Create a lead

post

https://api.surense.com/api/v1/leads

Create a new lead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to create a new lead

agencyId

uuid

Agency ID

externalId

string

External ID

reuseOpenLead

boolean

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.

templateId

string

Template ID

typeId

string

required

Type ID

sourceId

string

Source ID

statusId

string

Status ID

ownerId

string

Owner ID

assignedUserId

string

Assigned user ID

leadDate

string

Lead date

dueAt

string

Due date

dueAtTimeSet

boolean

Whether due time is set

dueDate

date

deprecated

dueTime

string

deprecated

notes

string

Lead notes

funnel

string

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

customerId

string

required

Customer ID

managerId

uuid

deprecated

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

string

Email address

phoneNumber1

string

Phone number 1

phoneNumber2

string

Phone number 2

street

string

Street name

streetNumber

string

Street number

apartmentNumber

string

Apartment number

mailBox

int32

Mail box number

zipCode

int32

ZIP code

city

string

City

gender

int32

enum

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

Allowed:

birthDate

string

Birth date

age

int32

Age

maritalStatus

int32

enum

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

Allowed:

childCount

int32

Number of children

employerName

string

Employer name

smoker

boolean

Smoker status

monthlyIncome

int32

Monthly income

employmentStatus

int32

enum

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

Allowed:

mailingStatus

int32

enum

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

Allowed:

forceCreation

boolean

Force creation

customFields

array of objects

Custom fields

customFields

utmId

string

UTM ID

utmSource

string

UTM source

utmMedium

string

UTM medium

utmCampaign

string

UTM campaign

utmTerm

string

UTM term

utmContent

string

UTM content

Response

Language

Credentials

OAuth2

Loading…

Response

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

*/*

200OK