Contacts API

Manage your WhatsApp contact list — create, update, tag, and delete contacts individually or bulk-import from CSV.

Endpoints

Method	Endpoint	Description
GET	https://api.vobiz.ai/v1/messaging/contacts	List all contacts
GET	https://api.vobiz.ai/v1/messaging/contacts/{id}	Get a single contact
POST	https://api.vobiz.ai/v1/messaging/contacts	Create a new contact
PUT	https://api.vobiz.ai/v1/messaging/contacts/{id}	Update a contact
DELETE	https://api.vobiz.ai/v1/messaging/contacts/{id}	Delete a contact
POST	https://api.vobiz.ai/v1/messaging/contacts/import	Bulk import from CSV

List Contacts

GEThttps://api.vobiz.ai/v1/messaging/contacts

Returns a paginated list of contacts. Filter by name/phone with search, or filter by tag.

Param	Default	Description
page	1	Page number
limit	25	Records per page
search		Search by name or phone
tag		Filter by tag name

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/v1/messaging/contacts?page=1&limit=25&search=Rahul&tag=vip" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

Response — 200 OK

{
  "data": [{"id":"cnt_xyz789","name":"Rahul Sharma","phone_number":"+919876543210","tags":["vip"],"created_at":"2026-03-01T10:00:00Z"}],
  "meta": {"total":1,"page":1,"limit":25}
}

Get Contact

GEThttps://api.vobiz.ai/v1/messaging/contacts/{contact_id}

Returns the full profile for a single contact by ID.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/v1/messaging/contacts/{contact_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

Create Contact

POSThttps://api.vobiz.ai/v1/messaging/contacts

Create a single contact. Attach tags and custom_attributes for filtering and campaign targeting.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X POST \
  "https://api.vobiz.ai/v1/messaging/contacts" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"phone_number":"+919876543210","name":"Rahul Sharma","tags":["vip"],"custom_attributes":{"company":"Acme"}}'

Update Contact

PUThttps://api.vobiz.ai/v1/messaging/contacts/{contact_id}

Update a contact's name, tags, or custom attributes.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X PUT \
  "https://api.vobiz.ai/v1/messaging/contacts/{contact_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rahul Kumar","tags":["vip","premium"]}'

Delete Contact

DELETEhttps://api.vobiz.ai/v1/messaging/contacts/{contact_id}

Permanently delete a contact from your account.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X DELETE \
  "https://api.vobiz.ai/v1/messaging/contacts/{contact_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

Import Contacts (CSV)

POSThttps://api.vobiz.ai/v1/messaging/contacts/import

Bulk-import contacts from a CSV file using multipart/form-data. CSV must include a phone_number column. Name and tags are optional.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

CSV format

phone_number,name,tags

+919876543210,Rahul Sharma,"vip,enterprise"

+919123456789,Priya Nair,"new"

cURL

curl -X POST \
  "https://api.vobiz.ai/v1/messaging/contacts/import" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -F "file=@/path/to/contacts.csv"

Note: Do not set Content-Type manually when using -F — curl sets the correct multipart boundary automatically.

Conversations API

Templates API

Last updated: April 2026Edit this page