Replay specific outbound messages by ID

POST

/v1/messages/replay-batch

• Production

Replay specific outbound messages by providing their IDs. Messages are re-enqueued for delivery to their configured endpoints.

Authorizations

• BearerAuth

Request Body ^required

object

message_ids

required

List of message IDs to replay

Array<string>

>= 1 items <= 100 items

Example

[
  "01935abc-def0-7123-4567-890abcdef012",
  "01935abc-def0-7123-4567-890abcdef013"
]

Example

{
  "message_ids": [
    "01935abc-def0-7123-4567-890abcdef012",
    "01935abc-def0-7123-4567-890abcdef013"
  ]
}

Responses

200

Messages replayed successfully

object

message

string

Example

2 messages replayed

data

object

replayed

Number of messages successfully re-enqueued

integer

Example

2

failed

Number of messages that failed to process

integer

0

stuck

Number of messages updated in DB but failed to enqueue

integer

0

results

Per-message replay results

Array<object>

object

message_id

The message ID

string

Example

01935abc-def0-7123-4567-890abcdef012

status

Result status for this message

string

Allowed values: replayed failed stuck

Example

replayed

error

Error message if the replay failed (only present for failed/stuck)

string

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "message": "2 messages replayed",
  "data": {
    "replayed": 2,
    "failed": 0,
    "stuck": 0,
    "results": [
      {
        "message_id": "01935abc-def0-7123-4567-890abcdef012",
        "status": "replayed"
      },
      {
        "message_id": "01935abc-def0-7123-4567-890abcdef013",
        "status": "replayed"
      }
    ]
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

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

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "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"
  }
}