Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Title

Title of the appointment

Text (Short)

Yes

Start date

Timestamp that denotes the start of appointment. Start date if this is an all-day appointment

Datetime

Yes

End date

Timestamp that denotes the end of appointment. End date if this is an all-day appointment

Datetime

Yes

Attendee type 1

Predefined Choice List

No

Attendee user ID 1

Text (Short)

No

Attendee contact ID 1

Text (Short)

No

Attendee type 2

Predefined Choice List

No

Attendee user ID 2

Text (Short)

No

Attendee contact ID 2

Text (Short)

No

Attendee type 3

Predefined Choice List

No

Attendee user ID 3

Text (Short)

No

Attendee contact ID 3

Text (Short)

No

Creator ID

ID of the user who created the appointment

Text (Short)

No

Is all-day?

Whether it is an all-day appointment or not

True/False

No

Latitude

Latitude of the location when you check in for an appointment

Text (Short)

No

Location

Location of the appointment

Text (Short)

No

Longitude

Longitude of the location when you check in for an appointment

Text (Short)

No

Outcome ID

ID of outcome of Appointment sales activity type

Text (Short)

No

Target ID

ID of contact/account against whom appointment is created

Text (Short)

No

Target type

Predefined Choice List

No

Time zone

Timezone that the appointment is scheduled in

Predefined Choice List

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.