List opt-outs
Returns the numbers on your opt-out list, newest first, including entries created from STOP, START and HELP keyword replies and the ones you added.
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/opt-outs \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.opt_outs.list_opt_outs(
limit=1,
offset=1,
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/opt-outs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "4e8b2d61-7c3a-4f9e-a1d5-9b6c0e2f8a37",
"accountId": "MA_XXXXXXXX",
"phoneNumber": "+14155550123",
"channel": "sms",
"reason": "manual",
"source": "manual",
"syncedToProvider": true,
"createdAt": "2026-10-18T07:23:03Z"
},
{
"id": "7b1d9f3e-2a6c-4e5b-8d0f-3c9a1e7b5d26",
"accountId": "MA_XXXXXXXX",
"phoneNumber": "+14155550124",
"channel": "sms",
"reason": "stop",
"source": "inbound",
"syncedToProvider": false,
"createdAt": "2026-10-17T19:04:40Z"
}
]{
"error": "missing or invalid credentials"
}{
"error": "internal error"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Query Parameters
Required. Maximum number of opt-outs to return, 1 or greater. Without it the response is null.
x >= 1Required. Number of records to skip before the page starts. Pass 0 for the first page, then add limit for each following page.
x >= 0Response
A page of opt-outs, or null when there are none.
Unique identifier of the opt-out record (UUID).
"4e8b2d61-7c3a-4f9e-a1d5-9b6c0e2f8a37"
Your Vobiz account ID (Auth ID), for example MA_XXXXXXXX.
"MA_XXXXXXXX"
The blocked phone number in E.164 format.
"+14155550123"
Channel the number is blocked on: sms, mms or rcs. An sms entry also blocks mms.
"sms"
Why the entry exists. stop, start or help when the contact replied with a keyword; manual or your own text when you created it through the API or console.
"manual"
inbound when the entry came from a keyword reply, manual when you created it through the API or console.
inbound, manual true when the block has also been applied on the upstream network.
When the number was added to the list (ISO 8601, UTC).
"2026-10-18T07:23:03Z"
Was this page helpful?
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/opt-outs \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.opt_outs.list_opt_outs(
limit=1,
offset=1,
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/opt-outs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "4e8b2d61-7c3a-4f9e-a1d5-9b6c0e2f8a37",
"accountId": "MA_XXXXXXXX",
"phoneNumber": "+14155550123",
"channel": "sms",
"reason": "manual",
"source": "manual",
"syncedToProvider": true,
"createdAt": "2026-10-18T07:23:03Z"
},
{
"id": "7b1d9f3e-2a6c-4e5b-8d0f-3c9a1e7b5d26",
"accountId": "MA_XXXXXXXX",
"phoneNumber": "+14155550124",
"channel": "sms",
"reason": "stop",
"source": "inbound",
"syncedToProvider": false,
"createdAt": "2026-10-17T19:04:40Z"
}
]{
"error": "missing or invalid credentials"
}{
"error": "internal error"
}