Name

Description

Data Type

Required?

Example

Connected account

The connected account to use for the request

Connected Account

Yes

Update by

The property via which to query the lead

Predefined Choice List

No

Value

Value of the property to identify the lead to update

Text (Long)

Yes

Avatar image

An avatar image URL. note: the image URL needs to be https

Link

No

Company ID 1

Identifies the companies this user belongs to

Text (Short)

No

Company ID 2

Identifies the companies this user belongs to

Text (Short)

No

Company ID 3

Identifies the companies this user belongs to

Text (Short)

No

Name

Name of the lead

Text (Short)

No

Phone

The phone number of the user

Text (Short)

No

Unsubscribed from emails?

Whether the Lead is unsubscribed from emails

True/False

No

Update last request at?

Whether to instruct Intercom to update the users last_request_at value to the current API service time in UTC. default value if not sent is false

True/False

No

UTM campaign

Identifies a specific product promotion or strategic campaign

Text (Short)

No

UTM content

Identifies what specifically was clicked to bring the user to the site

Text (Long)

No

UTM medium

Identifies what type of link was used

Text (Short)

No

UTM source

An avatar image URL. note: the image URL needs to be https

Link

No

UTM term

Identifies search terms

Text (Short)

No

Custom attribute 1 name

Text (Short)

No

Custom attribute 1 value

Text (Short)

No

Custom attribute 2 name

Text (Short)

No

Custom attribute 2 value

Text (Short)

No

Custom attribute 3 name

Text (Short)

No

Custom attribute 3 value

Text (Short)

No

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.