Move Conversation to CRM Step
Moves a conversation to a specified destination step within a CRM scenario.
The destination step can be identified by destStepId
or by scenarioId
and destStepIndex
.
Optionally, an initial message for the destination step can be sent.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
ID of the conversation to move.
ID of the CRM scenario. Required if destStepId
is not provided or to specify context for destStepIndex
.
ID of the destination CRM step. If provided, scenarioId
(if also provided) must match the step's scenario.
Index of the destination step within the scenario (used with scenarioId
if destStepId
is not provided).
Whether to send the initial message of the destination step.
Response
The ID of the new step the conversation was moved to.
Indicates if the initial message of the new step was sent.
Error message if sending the initial message failed.
The ID of the message that was sent (if any).
Indicates if sending a message was blocked by the 24-hour rule (e.g., for WhatsApp).
Was this page helpful?