Skip to main content
POST
Add a Phone Number to the Opt-Out Suppression List

Authorizations

Client-ID
string
header
required

Your UgaText Client-ID (e.g. uga_...). Accepted header aliases: X-Client-ID, or combined in Authorization: Bearer : / X-API-Key: :.

Client-Secret
string
header
required

Your UgaText Client-Secret (e.g. sk_live_...). Accepted header alias: X-Client-Secret.

Body

application/json
phone
string
required

Phone number to add to the opt-out list (accepted aliases: "phone_number", "recipient").

Example:

"+256700000000"

reason
string
Example:

"Customer requested opt-out"

sender_id
string
Example:

"UGATEXT"

Response

Phone number added to opt-out suppression list