Replay all matching outbound messages

POST

/v1/messages/replay-all

• Production

Replay multiple outbound messages matching the specified filters. Messages are re-enqueued for delivery to their configured endpoints.

Authorizations

• BearerAuth

Parameters

Query Parameters

status

required

string

Allowed values: failed_permanent pending_retry

Filter messages by status (only replayable statuses allowed)

Example

failed_permanent

endpoint_id

string

Filter by specific endpoint

Example

ep_01935abc

limit

integer

default: 100 >= 1 <= 1000

Maximum number of messages to replay

Example

100

Responses

200

Messages replayed successfully

object

message

string

Example

5 messages queued for replay

data

object

replayed

Number of messages successfully re-enqueued

integer

Example

5

failed

Number of messages that failed to process

integer

0

stuck

Number of messages updated in DB but failed to enqueue

integer

0

replayed_message_ids

IDs of successfully replayed messages

Array<string>

Example

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

stuck_message_ids

IDs of messages that were updated but failed to enqueue (empty array when none)

Array<string>

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "message": "5 messages queued for replay",
  "data": {
    "replayed": 5,
    "failed": 0,
    "stuck": 0,
    "replayed_message_ids": [
      "01935abc-def0-7123-4567-890abcdef012",
      "01935abc-def0-7123-4567-890abcdef013"
    ]
  },
  "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"
  }
}