POST
/
crm
/
step
/
move

Authorizations

Authorization
string
headerrequired

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

Body

application/json
conversationId
string
required

ID of the conversation to move.

scenarioId
string | null

ID of the CRM scenario. Required if destStepId is not provided or to specify context for destStepIndex.

destStepId
string | null

ID of the destination CRM step. If provided, scenarioId (if also provided) must match the step's scenario.

destStepIndex
integer | null

Index of the destination step within the scenario (used with scenarioId if destStepId is not provided).

shouldSendInitialMessage
boolean
default: false

Whether to send the initial message of the destination step.

Response

200 - application/json
success
boolean
message
string
newStepId
string

The ID of the new step the conversation was moved to.

messageSent
boolean | null

Indicates if the initial message of the new step was sent.

messageError
string | null

Error message if sending the initial message failed.

sentMessageId
string | null

The ID of the message that was sent (if any).

blockedBy24hRule
boolean | null

Indicates if sending a message was blocked by the 24-hour rule (e.g., for WhatsApp).