Sync a batch of engagements

Sync a batch of engagements

put/v1/integrations/sync/batch/engagements

Request

  • Base URL
    https://functions.siro.ai/api-externalApi
  • URL
    https://functions.siro.ai/api-externalApi/v1/integrations/sync/batch/engagements
  • Auth
    HTTP bearer

Request body

externalIdstring required

The ID of the engagement in the external system

direction'INBOUND' | 'OUTBOUND' nullable

The direction of the engagement (INBOUND/OUTBOUND)

contentstring nullable

The content of the engagement

subjectstring nullable

The subject of the engagement

startTimestring nullable

start dateTime of the engagement in UTC.

startTimeLocalizedstring nullable

Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes.

endTimestring nullable

end dateTime of the engagement

remoteCreatedAtstring nullable

external engagement creation datetime

remoteUpdatedAtstring nullable

external engagement update datetime

deletedAtstring date-time nullable

The datetime when this record was deleted in the external system

engagementTypeIdstring nullable

Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.

Response

Sync a batch of engagements

Changes

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