Create Opt-out

POST

https://api.sudonum.com.com/v2/campaign/opt-outs/

Creates an opt-out record for a contact. categories is required: send an empty list to opt the contact out of everything (a global opt-out), or one or more categories to opt them out of just those. sender_whatsapp_number is required too, since an opt-out always names one sending number. origin is recorded as API automatically.

Request

Body Params

application/json

Required

Examples

Global opt-out (empty categories)Opt out of specific categories

{
    "contact_number": "27710000001",
    "sender_whatsapp_number": "27820001234",
    "created_by": "support@example.com",
    "categories": [],
    "reason": "Customer asked to stop all messages"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Global opt-out (empty categories)Opt out of specific categories

curl --location 'https://api.sudonum.com.com/v2/campaign/opt-outs/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact_number": "27710000001",
    "sender_whatsapp_number": "27820001234",
    "created_by": "support@example.com",
    "categories": [],
    "reason": "Customer asked to stop all messages"
}'

Responses

🟢201

application/json

Created

Bodyapplication/json

Examples

Global opt-out (empty categories)Opt out of specific categories

{
    "contact_number": "27710000001",
    "sender_whatsapp_number": "27820001234",
    "message_id": null,
    "campaign_name": null,
    "opted_out_global": true,
    "opted_out_promotions": false,
    "opted_out_news": false,
    "opted_out_events": false,
    "opted_out_surveys": false,
    "origin": "API",
    "created": "2026-07-20T09:00:00Z",
    "created_by": "support@example.com",
    "reason": "Customer asked to stop all messages"
}

Modified at 2026-08-31 07:42:46

List of Opt-outs

List of Opt-out/Opt-in Events