Skip to content

Replay a message

POST
/v1/messages/{id}/replay

Re-enqueue a message for delivery. This creates a new delivery attempt using the original payload. Useful for recovering from transient failures or testing endpoints.

Limits: Maximum 10 replays per message.

id
required
string format: uuid

Unique message identifier (UUIDv7)

Example
01935abc-def0-7123-4567-890abcdef012

Message successfully re-enqueued

object
message
string
Example
Message queued for replay
data
object
message_id
string
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": "Message queued for replay",
"data": {
"message_id": "01935abc-def0-7123-4567-890abcdef012",
"status": "queued"
},
"meta": {
"request_id": "req_xyz123"
}
}

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"
}
}

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"
}
}

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"
}
}

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 10 times (limit: 10)"
},
"meta": {
"request_id": "req_xyz123"
}
}
Personalize Examples

Enter your credentials to populate code examples throughout the docs.