client Type

object (Client)

client Properties

Property	Type	Required	Nullable	Defined by
foreign_id	string	Optional	cannot be null	JsonLead
first_name	string	Optional	cannot be null	JsonLead
last_name	string	Optional	cannot be null	JsonLead
gdpr_consents	object	Optional	cannot be null	JsonLead
province	string	Optional	cannot be null	JsonLead
postal_code	string	Optional	cannot be null	JsonLead
phone	Merged	Optional	cannot be null	JsonLead
email	Merged	Optional	cannot be null	JsonLead
custom	object	Optional	cannot be null	JsonLead

foreign_id

A unique identifier that originates from an external database or system. It is meant to cross-reference the client on the destination database with the external system.

foreign_id

• is optional

• Type: string

• cannot be null

• defined in: JsonLead

foreign_id Type

string

first_name

The first name of the client

first_name

• is optional

• Type: string

• cannot be null

• defined in: JsonLead

first_name Type

string

last_name

The last name of the client

last_name

• is optional

• Type: string

• cannot be null

• defined in: JsonLead

last_name Type

string

gdpr_consents

gdpr_consents

• is optional

• Type: object (GDPR Consents)

• cannot be null

• defined in: JsonLead

gdpr_consents Type

object (GDPR Consents)

province

The province of the client

province

• is optional

• Type: string

• cannot be null

• defined in: JsonLead

province Type

string

postal_code

The postal code of the client

postal_code

• is optional

• Type: string

• cannot be null

• defined in: JsonLead

postal_code Type

string

phone

phone

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: JsonLead

phone Type

merged type (Details)

one (and only one) of

• Single phone number

• Array of phone numbers

email

email

• is optional

• Type: merged type (Details)

• cannot be null

• defined in: JsonLead

email Type

merged type (Details)

one (and only one) of

• Single email address

• Array of email addresses

custom

Custom fields for the client

custom

• is optional

• Type: object (Details)

• cannot be null

• defined in: JsonLead

custom Type

object (Details)