Cancel a pending retry

POST

/v1/messages/{id}/cancel

• Production

Cancel a message that is waiting for a scheduled retry. The message will be marked as failed_permanent and moved to the DLQ. Only works for messages in pending_retry status.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Unique message identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Retry cancelled successfully

object

data

object

message_id

string

status

string

Allowed values: failed_permanent

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "message_id": "01935abc-def0-7123-4567-890abcdef012",
    "status": "failed_permanent"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Message is not in pending_retry status

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "INVALID_STATUS",
    "message": "Message is not in pending_retry status (current: succeeded)"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

404

Resource not found

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Message not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}