Create Opportunity Appointment

Create a new appointment associated with an opportunity.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

opportunityIdstringRequired

Request

This endpoint expects an object.
titlestringRequired>=1 character
Appointment title
assigneeIdintegerRequired
ID of the user assigned to this appointment
dueDatestringRequiredformat: "date-time"

ISO 8601 scheduled date/time

descriptionstringOptional
Optional description

Response

Appointment created successfully
idinteger or null
titlestring or null
descriptionstring or null
dueDatestring or nullformat: "date-time"
isCompletedboolean or null
completedAtstring or nullformat: "date-time"
assigneeIdinteger or null
opportunityIdinteger or null
ID of the parent opportunity.
createdByinteger or null
createdAtstring or nullformat: "date-time"
updatedAtstring or nullformat: "date-time"

Errors