Update Opt-out

PATCH

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

Updates an opt-out record. Only the fields you send are changed -- so this is also how a contact is opted back in: set the relevant opted_out_* flag to false.

Request

Path Params

Body Params

application/json

Example

{
    "opted_out_promotions": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.sudonum.com.com/v2/campaign/opt-outs/123e4567-e89b-12d3-a456-426614174000/' \
--header 'Content-Type: application/json' \
--data '{
    "opted_out_promotions": false
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "contact_number": "27710000001",
    "sender_whatsapp_number": "27820001234",
    "message_id": null,
    "campaign_name": "Summer promo",
    "opted_out_global": false,
    "opted_out_promotions": false,
    "opted_out_news": false,
    "opted_out_events": false,
    "opted_out_surveys": false,
    "origin": "API",
    "created": "2026-07-21T10:15:00Z",
    "created_by": null,
    "reason": "Customer asked to stop promotions"
}

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

Replace Opt-out

Single Opt-out/Opt-in Event