Skip to main content
POST
Process Inbound STOP/START Keyword Webhook

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
from
string
required

Inbound sender phone number (accepted aliases: "phone", "sender", "msisdn").

Example:

"+256700000000"

text
string
required

Inbound SMS message text containing STOP/UNSUBSCRIBE or START/YES keyword (accepted aliases: "message", "body", "keyword").

Example:

"STOP"

campaignId
string
sendAutoReply
boolean
default:true

Response

Inbound opt-out or opt-in keyword processed