SUsurense
Leads

Create a lead

Create a new lead.

post/leads

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/leads
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: leads:create

Request body

agencyIdstring uuid

Agency ID

externalIdstring

External ID

reuseOpenLeadboolean

When true, append this submission as a contact point to the customer's newest open lead of the same type instead of creating a new lead. A new lead is still created if the customer has no open lead of that type. Defaults to false.

templateIdstring

Template ID

typeIdstring required

Type ID

sourceIdstring

Source ID

statusIdstring

Status ID

ownerIdstring

Owner ID

assignedUserIdstring

Assigned user ID

leadDatestring

Lead date

dueAtstring

Due date

dueAtTimeSetboolean

Whether due time is set

dueDatestring date
dueTimestring
notesstring

Lead notes

funnelstring

Funnel (free text) recorded on the contact point for this submission

customerIdstring required

Customer ID

managerIdstring uuid
firstNamestring

First name

lastNamestring

Last name

idType1 | 2 | 3 | 4 | 5 | 6

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

idNumberstring

Identity number

idCardIssueDatestring

ID card issue date

emailstring

Email address

phoneNumber1string

Phone number 1

phoneNumber2string

Phone number 2

streetstring

Street name

streetNumberstring

Street number

apartmentNumberstring

Apartment number

mailBoxinteger

Mail box number

zipCodeinteger

ZIP code

citystring

City

gender1 | 2 | 3

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

birthDatestring

Birth date

ageinteger

Age

maritalStatus1 | 2 | 3 | 4 | 5

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

childCountinteger

Number of children

employerNamestring

Employer name

smokerboolean

Smoker status

monthlyIncomeinteger

Monthly income

employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

Employment Status:<br/>1 - שכיר/ה<br/>2 - עצמאי/ת<br/>3 - שכיר/ה ועצמאי/ת<br/>4 - שכיר/ה בעל/ת שליטה<br/>5 - לא מועסק/ת<br/>6 - שכיר/ה בעל/ת שליטה ועצמאי/ת<br/>7 - פנסיונר/ית

mailingStatus1 | 2 | 3 | 4

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

forceCreationboolean

Force creation

utmIdstring

UTM ID

utmSourcestring

UTM source

utmMediumstring

UTM medium

utmCampaignstring

UTM campaign

utmTermstring

UTM term

utmContentstring

UTM content

Example request

{
  "agencyId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "EXT123456",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "typeId": "123e4567-e89b-12d3-a456-426614174000",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "assignedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "leadDate": "2024-01-15T10:00:00Z",
  "dueAt": "2024-01-15T10:00:00Z",
  "dueAtTimeSet": true,
  "notes": "Important lead information",
  "funnel": "Facebook - summer campaign",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "lastName": "Doe",
  "idType": 1,
  "idNumber": "123456789",
  "idCardIssueDate": "2020-01-15",
  "email": "john.doe@example.com",
  "phoneNumber1": "+972501234567",
  "phoneNumber2": "+972507654321",
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "5A",
  "mailBox": 1234,
  "zipCode": 12345,
  "city": "Tel Aviv",
  "gender": 1,
  "birthDate": "1990-01-15",
  "age": 34,
  "maritalStatus": 2,
  "childCount": 2,
  "employerName": "ABC Company",
  "monthlyIncome": 15000,
  "employmentStatus": 1,
  "mailingStatus": 1,
  "customFields": [
    {
      "fieldId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "utmId": "utm123",
  "utmSource": "google",
  "utmMedium": "cpc",
  "utmCampaign": "summer2024",
  "utmTerm": "insurance",
  "utmContent": "banner"
}

Response

OK

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:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

idNumberstring
idCardIssueDatestring date
firstNamestring
lastNamestring
customerFullNamestring
fullNamestring
customerFullNameReversestring
fullNameReversestring
cellNumberstring
phoneNumberstring
phoneNumber1string
phoneNumber2string
emailstring
otherEmailstring
customerStatusIdstring uuid
mailingStatus1 | 2 | 3 | 4

Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>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:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

birthDatestring date
deathboolean
ageinteger
maritalStatus1 | 2 | 3 | 4 | 5

Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>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.