Batch delete outbound messages by ID

POST

/v1/messages/delete-batch

• Production

Soft-delete a batch of outbound messages by their IDs. Returns per-ID outcomes: deleted, already_deleted, or not_found. Maximum 100 IDs per request.

Authorizations

• BearerAuth

Request Body ^required

object

message_ids

required

List of message IDs to delete (max 100)

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

Batch delete results

object

data

object

results

required

Array<object>

object

message_id

required

The message ID

string

outcome

required

The outcome for this message

string

Allowed values: deleted already_deleted not_found

deleted_at

Timestamp when the message was deleted (present for deleted and already_deleted outcomes)

string format: date-time

deleted_count

required

Number of messages newly deleted

integer

already_deleted_count

required

Number of messages that were already deleted

integer

not_found_count

required

Number of message IDs not found

integer

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "results": [
      {
        "message_id": "01935abc-def0-7123-4567-890abcdef012",
        "outcome": "deleted",
        "deleted_at": "2026-04-05T14:23:11.123Z"
      },
      {
        "message_id": "01935abc-def0-7123-4567-890abcdef013",
        "outcome": "not_found"
      }
    ],
    "deleted_count": 1,
    "already_deleted_count": 0,
    "not_found_count": 1
  },
  "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"
  }
}

500

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