v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Opt-Out Management

List opt-outs

Retrieve a list of opt-out blocks.

get/messaging_optouts

Query parameters

redaction_enabledstring

If receiving address (+E.164 formatted phone number) should be redacted

fromstring

The sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code) to retrieve opt-outs for

messaging_profile_idstring

The ID of the messaging profile to retrieve opt-outs for

Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

gtestring date-time

Filter opt-outs created after this date (ISO-8601 format)

ltestring date-time

Filter opt-outs created before this date (ISO-8601 format)

Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]

Response

Successful response with opt-out list data

Example response

{
  "data": [
    {
      "created_at": "2025-04-28 12:00:38.631252+00:00",
      "keyword": "STOP",
      "to": "+E.164"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}