Skip to main content
GET
List / check Do-Not-Contact
Use this to stop contacts on your other channels (WhatsApp, email, dialer) when they opt out on iMessage. Poll with since=, or subscribe to the dnc.added webhook to hear about each opt-out as it happens.

Authentication

Rate limit: 120 requests per minute per workspace (429 with Retry-After). Without since, entries are returned newest first.

Examples

Polling loop

  1. Store the addedAt of the last entry you processed (start with any past date).
  2. Call GET /api/dnc?since=<that addedAt>&limit=200.
  3. Skip ids you have already processed; process the rest.
  4. If hasMore is true, read page=2, page=3, … with the same since.
  5. Save the last entry’s addedAt and repeat (every few minutes is plenty).

Success response (200)

Check one number

Errors

Authorizations

Authorization
string
header
required

Workspace API key: Authorization: Bearer tuco_xxxxxxxxxxxxx

Query Parameters

since
string<date-time>

Only entries added at or after this time, oldest first. Inclusive — dedupe by id.

phone
string

Check one number (any common format). Adds listed to the response.

email
string

Check one email (case-insensitive). Adds listed to the response.

Substring match on phone or email

page
integer
default:1
Required range: x >= 1
limit
integer
default:50
Required range: 1 <= x <= 200

Response

Entries

entries
object[]
required
total
integer
required
page
integer
required
limit
integer
required
totalPages
integer
required
hasMore
boolean
required

true when another page exists

listed
boolean

Only when phone or email is passed: whether that contact is on the list