List opted-out numbers
Numbers on the Opt-Out List.
GET https://cotlet.dev/api/v1/clicksend/opt-outs
read
Returns the numbers on your Opt-Out List, 50 to a page; pass next_cursor back as cursor for the next page. Recipients land on this list when they reply STOP to an SMS campaign or click its unsubscribe link, and you can add numbers yourself. Being on this list does not remove a number from your other contact lists.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of a phone number. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/clicksend/opt-outs \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("clicksend", "list_opt_outs")const result = await cotlet.call('clicksend', 'list_opt_outs');cotlet call clicksend list_opt_outsExample response
{
"opt_outs": [
{
"phone_number": "+447700900142"
},
{
"phone_number": "+15550100234"
}
],
"next_cursor": null
}