API ReferenceEngagements

Create Engagement

Creates a new engagement record.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
memberslist of stringsRequired
IDs of the users that were part of the engagement.
scheduled_datestringRequiredformat: "date-time"
The date and time when the engagement was scheduled.
titlestringRequiredformat: "text"
The title of the engagement.
artifactslist of stringsOptional
The IDs of the artifacts to associate with the engagement.
descriptionstringOptionalformat: "text"
The description of the engagement.
engagement_typeenumOptional
The type of engagement.
Allowed values:
external_refstringOptionalformat: "text"
External Reference for the engagement.
external_urlstringOptionalformat: "text"
External URL for the engagement.
parentstringOptionalformat: "id"
The parent object ID in which the engagement was created. Currently, only accounts and opportunities are supported.
parentslist of stringsOptional
The parent object IDs to which the engagement is associated. Currently, only accounts and opportunities are supported.
tagslist of objectsOptional
Tags associated with the engagement.

Response

Success.
engagementobject

Errors