Create or Update Dispatch
Creates a new dispatch, or updates an existing one if an ID is provided in the body.
Creates a new dispatch or updates an existing one.
Body Parameters
The ID of the dispatch to update. If not provided, a new dispatch will be created.
The name of the dispatch.
The status of the dispatch.
The ID of the agent.
The ID of the CRM scenario.
The ID of the CRM step.
The ISO 8601 date-time for scheduling.
The message template.
The sending interval in minutes.
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Include the ID to update an existing dispatch. Omit to create a new one.
The name of the dispatch.
The status of the dispatch (e.g., 'draft', 'scheduled', 'sent').
The ID of the agent responsible for the dispatch.
The ID of the CRM scenario associated with the dispatch.
The ID of the CRM step associated with the dispatch.
The date and time the dispatch is scheduled to run.
The message template for the dispatch.
The interval in minutes between sending messages for the dispatch.
The ID of the default assignee for conversations created by this dispatch.
The default status for conversations created by this dispatch.
An array of contact list IDs to associate with the dispatch.
An array of contact list IDs to exclude from the dispatch.
Response
Was this page helpful?