MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
WhatsApp

List opt-outs

Who opted out of messages from this number, oldest first. By default it lists active opt-outs only.

Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.

GET/whatsapp/numbers//opt_outs
Path parameters
number_idrequired
Query parameters
activestring · enum

true for active only, false for lifted only, all for both.

customerstring

Find one customer by any spelling of their number.

limitinteger

Rows per page.

cursorstring

The next_cursor from the previous page.

curl -X GET 'https://backend.omnidim.io/api/v1/whatsapp/numbers/{number_id}/opt_outs?active=true&limit=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "data": [
    {
      "id": 0,
      "phone_number_id": 0,
      "customer": "+15551234567",
      "source": "instructed_keyword",
      "active": false,
      "opted_out_at": "string",
      "opted_in_at": "string",
      "note": "string"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

number_id*integer

Id of a WhatsApp number in your workspace, from listWhatsappNumbers. A number in another workspace answers 404.

Query Parameters

active?string

true for active only, false for lifted only, all for both.

Default"true"
Value intruefalse"all"
customer?string

Find one customer by any spelling of their number.

limit?integer

Rows per page.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor from the previous page.

Response body

application/json

Response Body

One page of opt-outs.

application/json
data?
has_more?boolean
next_cursor?string

Upload media

Upload an image or a document, then send it by its media_id on sendWhatsappMessage. Uploading costs nothing; only the send is charged. The media_id works for 24 hours and only for the number and type it was uploaded for.

Block a customer

Stop every message you start to this customer from this number, until the block is lifted. The response is 201 when the block is new and 200 when the customer was already blocked, in which case the entry is returned unchanged.