API de Gestion des Subscribers WhatChimp

Créez, mettez à jour, supprimez des subscribers et gérez les labels par programmation

Updated 10 February 2026

L'API de Gestion des Subscribers WhatChimp vous donne un contrôle total sur votre liste de subscribers (contacts). Créez, mettez à jour et supprimez des subscribers, gérez leurs labels et séquences, attribuez des custom fields, et plus encore — le tout via de simples requêtes HTTP.

Avant de commencer : Assurez-vous d'avoir votre API key et votre phone number ID. Consultez Getting Started with WhatChimp Developer API pour les instructions de configuration.

Video: https://www.youtube.com/watch?v=pYpWuoHSZlk

Obtenir un Subscriber

Récupérez les détails d'un subscriber spécifique par son numéro de téléphone.

Endpoint: POST /api/v1/whatsapp/subscriber/get

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/get

Parameters:

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/get' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "0123456789",
      "first_name": "john",
      "last_name": "Doe",
      "email": "test@gmail.com",
      "gender": "Male",
      "label_names": "Label1,Label2"
    }
  ]
}

Lister les Subscribers

Obtenez une liste paginée de tous vos subscribers.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/list

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/list

Parameters:

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1&orderBy=0

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/list' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'limit=10' \
  -d 'offset=1' \
  -d 'orderBy=0'

Sample Response:

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "0123456789",
      "first_name": "John",
      "last_name": "Doe",
      "email": "test@gmail.com",
      "gender": "male",
      "label_names": "One,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "0123456789",
      "first_name": "john",
      "last_name": "Doe",
      "email": null,
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}

Astuce : Utilisez offset pour paginer à travers de grandes listes de subscribers. Par exemple, récupérez les 50 premiers avec limit=50&offset=0, puis les 50 suivants avec limit=50&offset=50.

Créer un Subscriber

Ajoutez un nouveau subscriber (contact) à votre compte WhatsApp.

Endpoint: POST /api/v1/whatsapp/subscriber/create

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/create

Parameters:

Note : Cet endpoint utilise phoneNumberID et phoneNumber (camelCase), ce qui diffère de la plupart des autres endpoints qui utilisent phone_number_id et phone_number (snake_case).

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/create' \
  -d 'apiToken=API-KEY' \
  -d 'phoneNumberID=PHONE-NUMBER-ID' \
  -d 'name=NAME' \
  -d 'phoneNumber=MOBILE'

Sample Responses:

{"status": "1", "mesasge": "WhatsApp subscriber has been created."}

{"status": "0", "message": "WhatsApp account not found."}

{"status": "0", "message": "Subscriber limit has been exceeded. You cannot have more subscribers."}

{"status": "0", "message": "Something went wrong or subscriber already exist."}

Mettre à jour un Subscriber

Mettez à jour les détails d'un subscriber existant.

Endpoint: POST /api/v1/whatsapp/subscriber/update

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/update

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/update' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'first_name=FIRST-NAME' \
  -d 'last_name=LAST-NAME' \
  -d 'gender=GENDER' \
  -d 'label_ids=LABEL-IDS'

Sample Response:

{"status": "1", "message": "Subscriber Updated Successfully."}

Supprimer un Subscriber

Supprimez un subscriber de votre compte WhatsApp.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/delete

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/delete

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/delete' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{"status": "1", "message": "Subscriber has been deleted successfully."}

Opérations Avancées sur les Subscribers

Les endpoints suivants offrent des capacités supplémentaires de gestion des subscribers. Ces endpoints suivent le même schéma d'authentification — incluez apiToken dans chaque requête.

Réinitialiser le User Input Flow

Réinitialisez le user input flow actuel d'un subscriber, lui permettant de recommencer depuis le début.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/reset/user-input-flow

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow

Parameters:

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{"status":"1","message":"Reset User Input Flow successfully."}

Attribuer un Chat à un Membre de l'Équipe

Attribuez le chat d'un subscriber à un membre spécifique de l'équipe pour le suivi.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/chat/assign-to-team-member

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Parameters:

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'team_member_id=TEAM-MEMBER-ID'

Sample Response:

{"status":"1","message":"Successfully Assign Agent to Conversation."}

Attribuer des Custom Fields

Définissez les valeurs de custom fields pour un subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-custom-fields

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'custom_fields={"customer_name":"John Doe","customer_email":"john@example.com"}'

Sample Response:

{"status":"1","message":"Subscriber changes have been saved successfully."}

Liste des Custom Fields

Récupérez tous les custom fields configurés dans votre compte.

Endpoint: POST /api/v1/whatsapp/subscriber/custom-fields/list

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/custom-fields/list

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/custom-fields/list' \
  -d 'apiToken=API-KEY'

Sample Response:

{
  "status":"1",
  "message":"Custom fields retrieved successfully",
  "data":[
    {
      "id":1,
      "name":"customer_name",
      "reply_type":"text"
    },
    {
      "id":2,
      "name":"customer_email",
      "reply_type":"email"
    }
  ]
}

Attribuer des Labels

Ajoutez des labels à un subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-labels

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-labels

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-labels' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'label_ids=1,4,5'

Sample Response:

{"status":"1","message":"Labels have been assigned successfully."}

Supprimer des Labels

Supprimez des labels d'un subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-labels

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-labels

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-labels' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'label_ids=1,4,5'

Sample Response:

{"status":"1","message":"Labels have been assigned successfully."}

Attribuer une Séquence

Ajoutez un subscriber à une campagne de séquence (série de messages automatisés).

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-sequence

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-sequence

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-sequence' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'sequence_ids=1,4,5'

Sample Response:

{"status":"1","message":"Sequences have been assigned successfully."}

Supprimer une Séquence

Retirez un subscriber d'une campagne de séquence.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-sequence

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-sequence

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-sequence' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'sequence_ids=1,4,5'

Sample Response:

{"status":"1","message":"Sequences have been removed successfully."}

Ajouter des Notes à un Subscriber

Ajoutez une note au profil d'un subscriber pour référence interne.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/add-notes

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/add-notes

Parameters:

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/add-notes' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'note_text=Customer requested follow-up next week'

Sample Response:

{"status":"1","message":"Notes have been added successfully."}

Articles Connexes

• Getting Started with WhatChimp Developer API — Configuration de l'API, authentification et démarrage rapide
• WhatChimp Messaging API — Envoyer des messages et suivre la livraison
• WhatChimp Bot, Catalog & Utility APIs — Bot flows, catalogues, labels et plus