Skip to main content
PATCH
Bulk add to Do-Not-Contact
Use this to load an existing opt-out list, or to sync opt-outs from your other channels in batches. Contacts already on the list are counted as skipped, not errors, so it is safe to resend a whole batch after a timeout.Bulk adds do not fire the dnc.added webhook (you already know about these contacts). For one-at-a-time adds that should notify your webhooks, use POST /api/dnc.

Authentication

Phones are normalized to E.164 ((904) 555-1234 → +19045551234). Emails are stored lower case.

Example

Success response (200)

New entries have source: "api-bulk" in GET /api/dnc.

Errors

Authorizations

Authorization
string
header
required

Workspace API key: Authorization: Bearer tuco_xxxxxxxxxxxxx

Body

application/json
entries
object[]
required

Each item has a phone, an email, or both

Required array length: 1 - 10000 elements
Example:
reason
string
default:api-bulk
Example:

"whatsapp-opt-out"

Response

All saved

ok
boolean
required

false when failed > 0

added
integer
required

New entries created

skipped
integer
required

Already on the list

invalid
integer
required

Items with neither phone nor email

failed
integer
required

Could not be saved — resend the batch