Aller au contenu
Accueil » API SMS Octopush » Supprimer un contact

Supprimer un contact

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

Encodage : UTF-8

Authentification

Vos identifiants « api-key » et « api-login » doivent être ajoutés dans les headers.

Définition

Ce web service vous permet de supprimer un ou plusieurs contacts de votre compte ou d’une liste en particulier.

Paramètres particuliers

NomTypeDescription
phone_numbersstring[]Liste de numéros de téléphone :
[
  "+123123", 
  "+132323",
  ...
  ]
list_namestring(optionnel) Nom de la liste de laquelle le contact doit être supprimé.

Exemple Curl

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"
}'

Code à copier-coller

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"}'

Retour Server en json

Succès : 204 NO CONTENT

Limitations particulières

De 1 à 200 numéros.