Leads

Update a lead

Update a specific lead.

patch/leads/{id}

Request

Base URL
https://api.surense.com/api/v1
URL
https://api.surense.com/api/v1/leads/{id}
Auth
OAuth 2
Client credentials
Token URL: https://api.surense.com/oauth/token scopes: leads:update

Path parameters

idstring uuid required

Lead ID

Request body

typeIdstring

Lead type ID

statusIdstring

Lead status ID

agencyIdstring

Agency ID

ownerIdstring

Owner ID

assigneeIdstring

Assignee ID

sourceIdstring

Source ID

leadDatestring

Lead date

dueAtstring

Due date

dueAtTimeSetboolean

Whether due time is set

notesstring

Lead notes

priorityinteger

Lead priority (1-5)

firstNamestring

First name

lastNamestring

Last name

idType1 | 2 | 3 | 4 | 5 | 6

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

idNumberstring

Identity number

idCardIssueDatestring

ID card issue date

cellNumberstring

Cell phone number

phoneNumberstring

Phone number

phoneNumber1string

Phone number 1

phoneNumber2string

Phone number 2

emailstring

Email address

streetstring

Street name

streetNumberstring

Street number

apartmentNumberstring

Apartment number

postalBoxinteger

Postal box number

citystring

City

postalCodeinteger

Postal code

countrystring

Country

gender1 | 2 | 3

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

birthDatestring

Birth date

ageinteger

Age

deathboolean

Death status

maritalStatus1 | 2 | 3 | 4 | 5

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

smokerboolean

Smoker status

childCountinteger

Number of children

monthlyIncomeinteger

Monthly income

employerNamestring

Employer name

closedReasonstring

Closed reason

meetingDatestring

Meeting date

meetingTimestring

Meeting time

meetingLocationstring

Meeting location

meetingCoordinatorIdstring

Meeting coordinator ID

Example request

{
  "typeId": "123e4567-e89b-12d3-a456-426614174000",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "agencyId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "assigneeId": "123e4567-e89b-12d3-a456-426614174000",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "leadDate": "2024-01-15T10:00:00Z",
  "dueAt": "2024-01-15T10:00:00Z",
  "dueAtTimeSet": true,
  "notes": "Important lead information",
  "priority": 3,
  "firstName": "John",
  "lastName": "Doe",
  "idType": 1,
  "idNumber": "123456789",
  "idCardIssueDate": "2020-01-15",
  "cellNumber": "050-1234567",
  "phoneNumber": "03-1234567",
  "phoneNumber1": "03-1234567",
  "phoneNumber2": "03-7654321",
  "email": "john.doe@example.com",
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "5A",
  "postalBox": 1234,
  "city": "Tel Aviv",
  "postalCode": 12345,
  "country": "Israel",
  "gender": 2,
  "birthDate": "1990-01-15",
  "age": 34,
  "maritalStatus": 2,
  "childCount": 2,
  "monthlyIncome": 15000,
  "employerName": "ABC Company",
  "closedReason": "Not interested",
  "meetingDate": "2024-01-15",
  "meetingTime": "14:30",
  "meetingLocation": "Office",
  "meetingCoordinatorId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

tenantIdstring uuid

agencyIdstring uuid

createdDatestring date-time

createdBystring uuid

creatorNamestring

lastModifiedDatestring date-time

lastModifiedBystring uuid

versioninteger

idstring uuid

numberinteger

externalIdstring

documentCountinteger

ownerIdstring uuid

ownerNamestring

assigneeIdstring uuid

assigneeNamestring

assignedUserIdstring uuid

assignedUserNamestring

assignedAtstring date-time

assignedBystring uuid

interestIdstring uuid

interestNamestring

statusIdstring uuid

statusNamestring

statusSuccessboolean

statusClosedboolean

statusDatestring date-time

lastStatusUpdateBystring uuid

priorityinteger

leadDatestring date-time

successDatestring date

closedDatestring date

closedReasonstring

dueDatestring date

dueTimestring

dueAtstring date-time

dueAtTimeSetboolean

overduePeriodstring

sourceIdstring uuid

existingLeadboolean

customerIdstring uuid

customerManagerIdstring uuid

customerManagersstring[]

idType1 | 2 | 3 | 4 | 5 | 6

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

idNumberstring

idCardIssueDatestring date

firstNamestring

lastNamestring

customerFullNamestring

fullNamestring

customerFullNameReversestring

fullNameReversestring

cellNumberstring

phoneNumberstring

phoneNumber1string

phoneNumber2string

emailstring

otherEmailstring

customerStatusIdstring uuid

mailingStatus1 | 2 | 3 | 4

Mailing Status: 1 - אושר דיוור 2 - לא אושר דיוור 3 - הוסר מדיוור 4 - לא התבקש אישור

customerDeathboolean

swiftnessProxyInviteDatestring date

swiftnessProxySignDatestring date

swiftnessProxyExpiredboolean

lastE9100DataDatestring date

hbProxyInviteDatestring date

hbProxySignDatestring date

hbProxyExpiredboolean

hbDataDatestring date

policiesProxyInviteDatestring date

policiesProxySignDatestring date

streetstring

streetNumberstring

apartmentNumberstring

postalBoxinteger

citystring

postalCodeinteger

gender1 | 2 | 3

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

birthDatestring date

deathboolean

ageinteger

maritalStatus1 | 2 | 3 | 4 | 5

Marital Status: 1 - רווק/ה 2 - נשוי/אה 3 - גרוש/ה 4 - אלמן/ה 5 - ידוע/ה בציבור

professionstring

monthlyIncomeinteger

notesstring

unseenboolean

employerNamestring

smokerboolean

meetingDatestring date

meetingTimestring

meetingFirstScheduledDatestring date-time

meetingFirstScheduledByIdstring uuid

meetingFirstScheduledByNamestring

meetingCoordinatedDatestring date-time

meetingCoordinatedByIdstring uuid

meetingCoordinatedByNamestring

meetingLocationstring

meetingCoordinatorIdstring uuid

meetingCoordinatorNamestring

tagsstring[]

lastActivityDatestring date-time

lastActivityBystring uuid

sharableboolean

appMailAddressstring

lastExternalPartyIdstring uuid

lastTransferDatestring date-time

utmIdstring

utmSourcestring

utmMediumstring

utmCampaignstring

utmTermstring

utmContentstring

contactPointCountinteger

lastContactPointDatestring date-time

typeIdstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.