Skip to content
Home » Octopush Gateway SMS API » Empty a contact list

Empty a contact list

POST
https://api.octopush.com/v1/public/contact-list/empty

Encodage : UTF-8

Authentification

Your “api-key” and “api-login” identifiers must be added in the headers.

Definition

This web service allows you to empty a contact list. This service is synchronous.

Special parameters

NameTypeDescription
list_namestringName of the list to be emptied.

Curl Example

curl -X POST \ 
'https://api.octopush.com/v1/public/contact-list/empty' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "list_name": "my_list"
}'

Command to copy/paste

curl -X POST 'https://api.octopush.com/v1/public/contact-list/empty' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"list_name": "my_list"}'

JSON Server Response

Success : 200 OK