Communication Preferences
Recent SMS Opt-out
Retrieves a list of the most recent SMS opt-out changes for each phone numbers used in your workspace.
📘 You can filter results by time range using timestamp_from and timestamp_to.
get/public/v1/sms-opt-outs
Query parameters
timestamp_fromstring date-time
The start of the timestamp.
If no timestamp is provided, 1 hour before the current time will be used.
timestamp_tostring date-time
The end of the timestamp range.
If no timestamp is provided the current time will be used.
Response
A list of phone numbers, their SMS current opt-out statuses and timestamp of the last change.
Example response
{
"results": [
{
"phone_number": "+1234567890",
"status": "opt-out",
"opt_out_changed": "2025-01-28T12:00:00Z"
}
]
}