Skip to content

Delete a message

DELETE
/v1/messages/{id}

Soft-delete a single outbound message. The payload becomes immediately unreachable; the S3 object is removed by the sweeper on its next run. Metadata and delivery-attempt history are preserved. The original status is kept unchanged.

Idempotent: deleting an already-deleted message returns 200 with already_deleted: true and the original deleted_at timestamp.

id
required
string format: uuid

Unique message identifier (UUIDv7)

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

Message deleted (or already deleted)

object
data
object
message_id
required

The deleted message ID

string
Example
01935abc-def0-7123-4567-890abcdef012
deleted_at
required

Timestamp when the message was deleted

string format: date-time
Example
2026-04-05T14:23:11.123Z
already_deleted
required

True if the message was already deleted before this call

boolean
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",
"deleted_at": "2026-04-05T14:23:11.123Z",
"already_deleted": false
},
"meta": {
"request_id": "req_xyz123"
}
}

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

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

Internal server error

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": "INTERNAL_ERROR",
"message": "An internal error occurred"
},
"meta": {
"request_id": "req_xyz123"
}
}
Personalize Examples

Enter your credentials to populate code examples throughout the docs.