WhatChimp Subscriber Management API
Subscribers ko programmatically create, update, delete karein aur labels manage karein
Updated 10 February 2026
WhatChimp Subscriber Management API aapko apni subscriber (contact) list par poora control deti hai. Subscribers create, update aur delete karein, unke labels aur sequences manage karein, custom fields assign karein, aur bahut kuch — sab kuch simple HTTP requests ke through.
Shuru karne se pehle: Apna API key aur phone number ID ready rakhein. Setup instructions ke liye Getting Started with WhatChimp Developer API dekhein.
Video: https://www.youtube.com/watch?v=pYpWuoHSZlk
Subscriber Prapt Karein
Kisi specific subscriber ki details unke phone number se prapt karein.
Endpoint: POST /api/v1/whatsapp/subscriber/get
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/get

Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
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"
}
]
}
Subscribers Ki List
Apne sabhi subscribers ki paginated list prapt karein.
Endpoint: GET/POST /api/v1/whatsapp/subscriber/list
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/list
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
limit | Number | Yes | Number of subscribers to return |
offset | Number | No | Pagination offset (start from this position) |
orderBy | Number | No | Set to 1 to sort by most recent message (latest first). Set to 0 for default order. |
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"
}
]
}
Tip: Badi subscriber lists mein paginate karne ke liye offset use karein. For example, pehle 50 ke liye limit=50&offset=0, phir agle 50 ke liye limit=50&offset=50.
Subscriber Banayein
Apne WhatsApp account mein ek naya subscriber (contact) add karein.
Endpoint: POST /api/v1/whatsapp/subscriber/create
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/create

Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phoneNumberID | String | Yes | Your WhatsApp phone number ID |
name | String | Yes | Name of the subscriber |
phoneNumber | String | Yes | Subscriber's phone number with country code (no + sign) |
Note: Ye endpoint phoneNumberID aur phoneNumber (camelCase) use karta hai, jo baaki endpoints se alag hai jo phone_number_id aur phone_number (snake_case) use karte hain.
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."}
Subscriber Update Karein
Ek existing subscriber ki details update karein.
Endpoint: POST /api/v1/whatsapp/subscriber/update
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/update
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
first_name | String | No | First name |
last_name | String | No | Last name |
gender | String | No | Gender |
label_ids | String | No | Label IDs, comma-separated (e.g., 1,4,5) |
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."}
Subscriber Delete Karein
Apne WhatsApp account se ek subscriber ko hatayein.
Endpoint: GET/POST /api/v1/whatsapp/subscriber/delete
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/delete
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number with country code, numeric only |
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."}
Advanced Subscriber Operations
Neeche diye gaye endpoints subscriber management ke liye additional capabilities provide karte hain. Ye sabhi endpoints same authentication pattern follow karte hain — har request mein apiToken include karein.
User Input Flow Reset Karein
Ek subscriber ka current user input flow reset karein, jisse wo shuru se dubara start kar sake.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
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."}
Chat Ko Team Member Ko Assign Karein
Ek subscriber ki chat ko follow-up ke liye kisi specific team member ko assign karein.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
team_member_id | Integer | Yes | ID of the team member to assign |
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."}
Custom Fields Assign Karein
Ek subscriber ke liye custom field values set karein.
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
custom_fields | JSON | Yes | Custom field names and values as JSON object (e.g., {"custom_filed_name1": "custom_field_value1","custom_filed_name2": "custom_field_value2"}) |
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."}
Custom Fields Ki List
Apne account mein configure kiye gaye sabhi custom fields prapt karein.
Endpoint: POST /api/v1/whatsapp/subscriber/custom-fields/list
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/custom-fields/list
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
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"
}
]
}
Labels Assign Karein
Ek subscriber ko labels add karein.
Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-labels
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-labels

Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
label_ids | String | Yes | Label IDs, comma-separated (e.g., 1,4,5) |
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."}
Labels Hatayein
Ek subscriber se labels remove karein.
Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-labels
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-labels
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
label_ids | String | Yes | Label IDs to remove, comma-separated |
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."}
Sequence Assign Karein
Ek subscriber ko sequence campaign (automated message series) mein add karein.
Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-sequence
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-sequence
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
sequence_ids | String | Yes | Sequence IDs, comma-separated (e.g., 1,4,5) |
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."}
Sequence Hatayein
Ek subscriber ko sequence campaign se remove karein.
Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-sequence
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-sequence
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
sequence_ids | String | Yes | Sequence IDs to remove, comma-separated |
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."}
Subscriber Mein Notes Add Karein
Internal reference ke liye subscriber ke profile mein ek note add karein.
Endpoint: POST /api/v1/whatsapp/subscriber/chat/add-notes
Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/add-notes
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
apiToken | String | Yes | Your WhatChimp API key |
phone_number_id | String | Yes | Your WhatsApp phone number ID |
phone_number | String | Yes | Subscriber's phone number |
note_text | String | Yes | The note text to add |
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."}
Related Articles
- Getting Started with WhatChimp Developer API — API setup, authentication, aur quick start
- WhatChimp Messaging API — Messages bhejein aur delivery track karein
- WhatChimp Bot, Catalog & Utility APIs — Bot flows, catalogs, labels, aur bahut kuch