API de Gerenciamento de Subscribers do WhatChimp

Crie, atualize, exclua subscribers e gerencie labels programaticamente

Updated 10 February 2026

A API de Gerenciamento de Subscribers do WhatChimp oferece controle total sobre sua lista de subscribers (contatos). Crie, atualize e exclua subscribers, gerencie seus labels e sequências, atribua custom fields e muito mais — tudo através de requisições HTTP simples.

Antes de começar: Certifique-se de ter sua API key e phone number ID. Veja Getting Started with WhatChimp Developer API para instruções de configuração.

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

Obter Subscriber

Recupere os detalhes de um subscriber específico pelo número de telefone.

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

Listar Subscribers

Obtenha uma lista paginada de todos os seus 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"
    }
  ]
}

Dica: Use offset para paginar através de listas grandes de subscribers. Por exemplo, busque os primeiros 50 com limit=50&offset=0, depois os próximos 50 com limit=50&offset=50.

Criar Subscriber

Adicione um novo subscriber (contato) à sua conta WhatsApp.

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

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

Parameters:

Nota: Este endpoint usa phoneNumberID e phoneNumber (camelCase), o que difere da maioria dos outros endpoints que usam phone_number_id e 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."}

Atualizar Subscriber

Atualize os detalhes de um subscriber existente.

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

Excluir Subscriber

Remova um subscriber da sua conta 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."}

Operações Avançadas de Subscriber

Os endpoints a seguir oferecem capacidades adicionais de gerenciamento de subscribers. Esses endpoints seguem o mesmo padrão de autenticação — inclua apiToken em cada requisição.

Resetar User Input Flow

Resete o user input flow atual de um subscriber, permitindo que ele recomece do início.

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

Atribuir Chat a Membro da Equipe

Atribua o chat de um subscriber a um membro específico da equipe para acompanhamento.

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

Atribuir Custom Fields

Defina valores de custom fields para um 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."}

Lista de Custom Fields

Recupere todos os custom fields configurados na sua conta.

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

Atribuir Labels

Adicione labels a um 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."}

Remover Labels

Remova labels de um 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."}

Atribuir Sequência

Adicione um subscriber a uma campanha de sequência (série de mensagens automatizadas).

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

Remover Sequência

Remova um subscriber de uma campanha de sequência.

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

Adicionar Notas a um Subscriber

Adicione uma nota ao perfil de um subscriber para referência interna.

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

Artigos Relacionados

• Getting Started with WhatChimp Developer API — Configuração da API, autenticação e início rápido
• WhatChimp Messaging API — Enviar mensagens e rastrear entregas
• WhatChimp Bot, Catalog & Utility APIs — Bot flows, catálogos, labels e mais