Name

Description

Data Type

Required?

Example

Connected account

The connected account to use for the request

Connected Account

Yes

Person ID

ID of the person to update

Number

Yes

Custom property 1 ID

Name of the custom field to set

Text (Short)

No

Custom property 1 value

Value of the property to set

Text (Long)

No

Custom property 2 ID

Name of the custom field to set

Text (Short)

No

Custom property 2 value

Value of the property to set

Text (Long)

No

Custom property 3 ID

Name of the custom field to set

Text (Short)

No

Custom property 3 value

Value of the property to set

Text (Long)

No

Email

Email of the person

Email

No

Label ID

Text (Short)

No

Marketing status

Please be aware that it is only allowed once to change the marketing status from an old status to a new one

Predefined Choice List

No

Person name

The name of the person

Text (Short)

No

Organization ID

ID of the organization this deal will be associated with

Text (Short)

No

Phone number

Phone number of the person

Text (Short)

No

User ID

ID of the User this person will be associated with

Text (Short)

No

Visible to

Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user

Predefined Choice List

No

Encode properties?

By default do custom properties have to be set as ID instead of their actual name. Also option fields have to be set as ID instead of their actual value. If this option gets set they get automatically encoded

True/False

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.