Skip to main content
POST
Disable notification preference (server-to-server)

Authorizations

X-API-KEY
string
header
required

Server-to-Server API Key for internal/lambda/cron calls

Body

application/json
mobiles
string[]
required

Array of mobile phone numbers to look up users and disable all their notification preferences

Example:

Response

200 - application/json

Preferences disabled

status
boolean
Example:

true

message
string
Example:

"Notification preferences updated."

total_preferences_updated
integer
Example:

1

users_with_preference_changes
integer
Example:

1