Sign in
Sequences

Retry failed sequence step

Requires Full Access or Operator (CAN_ENROLL) sharing level on the sequence. Requires Idempotency-Key and explicit confirmation when the retry may resend a message.

post/public/v1/sequences/{sequenceId}/recipients/{instanceId}/retry

Path parameters

sequenceIdinteger required
Example:1
instanceIdinteger required
Example:1

Headers

idempotency-keystring required
Example:example value

Request body

reasonstring required
confirmResendboolean

Example request

{
  "reason": "example"
}

Response

Retry outcome

outcome'CONFIRMATION_REQUIRED' | 'IN_PROGRESS' | 'EXECUTED' | 'EXECUTION_FAILED' | 'NOT_EXECUTED' required
operationIdstring required
idempotencyKeystring required
duplicateboolean required
requiresSendConfirmationboolean required
channel'EMAIL' | 'WHATSAPP'
codestring
instanceStatus'ACTIVE' | 'WAITING' | 'PAUSED' | 'COMPLETED' | 'EXITED' | 'FAILED' | 'REMOVED'
failedAttemptIdstring
resendConfirmedboolean
errorstring

Example response

{
  "outcome": "CONFIRMATION_REQUIRED",
  "operationId": "example",
  "idempotencyKey": "example",
  "channel": "EMAIL",
  "code": "example",
  "instanceStatus": "ACTIVE",
  "failedAttemptId": "example",
  "error": "example"
}

Changes

Changed in 1 of the 2 revisions of this API.1