Skip to main content
GET
/
v1
/
messaging
/
contacts
Contacts API
curl --request GET \
  --url https://api.example.com/v1/messaging/contacts

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
Endpoints overview

MethodEndpointDescription
GET/v1/messaging/contactsList all contacts
GET/v1/messaging/contacts/{id}Get a single contact
POST/v1/messaging/contactsCreate a new contact
PUT/v1/messaging/contacts/{id}Update a contact
DELETE/v1/messaging/contacts/{id}Delete a contact
POST/v1/messaging/contacts/importBulk import from CSV

​
List contacts

GET https://api.vobiz.ai/v1/messaging/contacts
Returns a paginated list of contacts. Filter by name/phone with search, or filter by tag.
ParamDefaultDescription
page1Page number
limit25Records per page
search-Search by name or phone
tag-Filter by tag name
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}"
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

GET https://api.vobiz.ai/v1/messaging/contacts/{contact_id}
Returns the full profile for a single contact by ID.
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

POST https://api.vobiz.ai/v1/messaging/contacts
Create a single contact. Attach tags and custom_attributes for filtering and campaign targeting.
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

PUT https://api.vobiz.ai/v1/messaging/contacts/{contact_id}
Update a contact’s name, tags, or custom attributes.
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

DELETE https://api.vobiz.ai/v1/messaging/contacts/{contact_id}
Permanently delete a contact from your account.
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)

POST https://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. 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"
Do not set Content-Type manually when using -F - curl sets the correct multipart/form-data boundary automatically.