Update a lead

patch

https://api.surense.com/api/v1/leads/{id}

Update a specific lead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Example:

{
    "statusId": "4cabc231-c789-4605-884b-3b2dd2fa1c1d"
}

Path Params

uuid

required

Lead ID

Body Params

Request to update a lead

pinned

boolean

Whether the lead is pinned

typeId

string

Lead type ID

statusId

string

Lead status ID

agencyId

string

Agency ID

ownerId

string

Owner ID

assigneeId

string

Assignee ID

sourceId

string

Source ID

leadDate

string

Lead date

dueAt

string

Due date

dueAtTimeSet

boolean

Whether due time is set

notes

string

Lead notes

priority

int32

Lead priority (1-5)

firstName

string

First name

lastName

string

Last name

idType

int32

enum

Customer Identity Type:
1 - ת.ז
2 - דרכון
3 - רישיון נהיגה
4 - אחר
5 - ח.פ
6 - ח.צ

Allowed:

idNumber

string

Identity number

idCardIssueDate

string

ID card issue date

cellNumber

string

Cell phone number

phoneNumber

string

Phone number

phoneNumber1

string

Phone number 1

phoneNumber2

string

Phone number 2

string

Email address

street

string

Street name

streetNumber

string

Street number

apartmentNumber

string

Apartment number

postalBox

int32

Postal box number

city

string

City

postalCode

int32

Postal code

country

string

Country

gender

int32

enum

Gender:
1 - לא מוגדר
2 - זכר
3 - נקבה

Allowed:

birthDate

string

Birth date

age

int32

Age

death

boolean

Death status

maritalStatus

int32

enum

Marital Status:
1 - Single
2 - Married
3 - Divorced
4 - Widowed
5 - Cohabiting

Allowed:

smoker

boolean

Smoker status

childCount

int32

Number of children

monthlyIncome

int32

Monthly income

employerName

string

Employer name

closedReason

string

Closed reason

meetingDate

string

Meeting date

meetingTime

string

Meeting time

meetingLocation

string

Meeting location

meetingCoordinatorId

string

Meeting coordinator ID

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK