Skip to content

Contacts

Every endpoint on this page needs the /contacts grant.

POST /contacts/create-contact

Field Required Description
contact_number Yes Phone number with country code
name No Display name
email No Email address
group_ids No IDs of existing contact groups to add the contact to
dateOfBirth, gender No Profile fields
instagramUrl, facebookUrl, linkedinUrl No Social profile links
Terminal window
curl -X POST https://api.wabot.shop/contacts/create-contact \
-H "Authorization: $TOKEN" -H "Content-Type: application/json" \
-d '{"contact_number": "+919400294110", "name": "Asha", "email": "asha@example.com", "group_ids": [12]}'
{ "data": { "contact": { "contact_id": 381, "name": "Asha", "contact_number": "919400294110" }, "message": "Created a new contact" } }

If the number already exists, the existing contact is returned with "message": "The contact is already existing", so it’s safe to call this endpoint more than once for the same number.

If a group ID doesn’t exist, the response is:

{ "message": "Not all groups exist in the database for this account.", "missingGroups": [99] }

GET /v2/contacts

Query Default Description
search Matches name, number or email
phone Exact phone lookup (the + is optional)
page 1 Page number
pageSize 20 Up to 100
Terminal window
curl "https://api.wabot.shop/v2/contacts?phone=919400294110" -H "Authorization: $TOKEN"
{
"data": {
"contacts": [
{
"contact_id": 381,
"name": "Asha",
"contact_number": "919400294110",
"email": "asha@example.com",
"isBlocked": false,
"platform": "whatsapp",
"created_at": "2026-09-01T10:12:00.000Z"
}
],
"page": 1,
"pageSize": 20,
"total": 1
}
}

Contacts are sorted newest first.