post
https://api.octopush.com/v1/public/contact/optout
Encoding : UTF-8
Authentication
Your "api-key" and "api-login" identifiers must be added in the headers.
Definition
This web service allows you to optout a list of email addresses and/or phone numbers.
Special parameters
| Name | Type | Description |
|---|---|---|
| phone_numbers | array | Array of phone numbers to optout. Maximum 200 phone numbers. |
| emails | array | Array of email addresses to optout. Maximum 200 email addresses. |
Server Response Example in JSON
Success
{
"optout_numbers_count": 2,
"optout_emails_count": 2
}
The counters only take into account the contacts that were really added to your optout list : already opted out
or invalid phone numbers are ignored.
Bad request.
Unauthorized.
Forbidden.