Replay inbound message

POST

/v1/inbound-messages/{id}/replay

• Production

Replay a single inbound message. The message will be re-enqueued for delivery to the configured forwarding URL.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Inbound message identifier (UUIDv7)

Example

01935abc-def0-7123-4567-890abcdef012

Responses

200

Inbound message queued for replay

object

message

string

Example

Inbound message queued for replay

data

object

message_id

string format: uuid

Example

01935abc-def0-7123-4567-890abcdef012

status

string

Allowed values: queued

Example

queued

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "message": "Inbound message queued for replay",
  "data": {
    "message_id": "01935abc-def0-7123-4567-890abcdef012",
    "status": "queued"
  },
  "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"
  }
}

409

Message cannot be replayed due to its current state. Possible error codes: ALREADY_DELIVERED (message already succeeded), DELIVERY_IN_PROGRESS (message is currently being delivered), RETRY_IN_PROGRESS (message is in active fast retry after a 429 response).

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

Fast retry in progress

{
  "error": {
    "code": "RETRY_IN_PROGRESS",
    "message": "Message is in active fast retry; wait for retries to complete or fail before replaying"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Already delivered

{
  "error": {
    "code": "ALREADY_DELIVERED",
    "message": "Message has already been delivered successfully and cannot be replayed"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Delivery in progress

{
  "error": {
    "code": "DELIVERY_IN_PROGRESS",
    "message": "Message is currently being delivered; wait for delivery to complete before replaying"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

429

Replay limit exceeded

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": "REPLAY_LIMIT_EXCEEDED",
    "message": "Message has already been replayed the maximum number of times"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

503

Inbound queue not configured

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