Skip to content
Home » Octopush Gateway SMS API » Delete a contact

Delete a contact

DELETE
https://api.octopush.com/v1/public/contact/delete

Encodage : UTF-8

Authentification

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

Definition

This web service allows you to delete one or more contacts from your account or from a particular list.

Special parameters

NameTypeDescription
phone_numbersstring[]List of telephone numbers :
[
  "+123123", 
  "+132323",
  ...
  ]
list_namestring(optional) Name of the list from which the contact is to be deleted.

Curl Example

curl -X DELETE \ 
'https://api.octopush.com/v1/public/contact/delete' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "phone_numbers": [
    "+12312345",
    "+3234132323"
  ],
  "list_name": "my_list"
}'

Command to copy/paste

curl -X DELETE 'https://api.octopush.com/v1/public/contact/delete' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"phone_numbers": ["+12312345", "+3234132323"], "list_name": "my_list"}'

JSON Server Response

Succes : 204 NO CONTENT

Specific limitations

From 1 to 200 contacts.