Get an engagement

Get an engagement

get/v1/integrations/engagements/{id}

Request

  • Base URL
    https://functions.siro.ai/api-externalApi
  • URL
    https://functions.siro.ai/api-externalApi/v1/integrations/engagements/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

Get an engagement

idstring required
externalIdstring required

The ID of the engagement in the external system (e.g. Salesforce)

engagementTypestring required

The type of the engagement

directionstring

"INBOUND" | "OUTBOUND"

subjectstring

The subject of the engagement

contentstring

The content of the engagement

startTimestring

The start time of the engagement

startTimeLocalizedstring

Localized dateTime of the engagement, without timezone info

endTimestring

The end time of the engagement

createdAtstring required

The date the engagement was created

updatedAtstring required

The date the engagement was last updated

recordingIdstring

The ID of the recording associated to the engagement

opportunityIdstring

The ID of the opportunity associated to the engagement

accountIdstring
organizationIdstring required
accountunknown

Changes

No recorded changes to this operation across all 1 revision of this API.