API Reference5 min read · Updated 2026-06-01

Contacts API

Create, read, update, and delete contacts in BuzzBip Audience. Sync customer profiles from your CRM or e-commerce platform.

The Contacts API manages records in BuzzBip Audience. Phone number is the primary identifier for WhatsApp contacts and must be in E.164 format.

Endpoints

Method	Endpoint	Description
`GET`	`/contacts`	List contacts with pagination
`POST`	`/contacts`	Create or upsert a contact by phone
`GET`	`/contacts/{id}`	Retrieve a contact by ID
`PUT`	`/contacts/{id}`	Update contact fields and tags
`DELETE`	`/contacts/{id}`	Delete a contact

Create a contact

bash

curl -X POST "https://api.buzzbip.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+21612345678",
    "firstName": "Walid",
    "lastName": "Ben Ali",
    "email": "[email protected]",
    "tags": ["vip", "woocommerce"]
  }'

Request body fields

Field	Type	Required	Description
phone	string	Yes	E.164 phone number (e.g. +21612345678)
firstName	string	No	Contact first name
lastName	string	No	Contact last name
email	string	No	Contact email address
tags	string[]	No	Labels for segmentation and workflows
customFields	object	No	Key-value custom field map

Update a contact

Use PUT /contacts/{id} to update fields. Only include properties you want to change. Tags are replaced when the tags array is provided.

json

{
  "firstName": "Walid",
  "tags": ["vip", "returning-customer"],
  "customFields": {
    "loyaltyTier": "gold"
  }
}

Upsert behavior

POST /contacts creates a new contact or updates an existing one when the phone number already exists in your workspace.

Deleting a contact removes it from Audience but does not delete past conversation history. Contact your account manager if you need GDPR erasure.

Webhooks: contact events →

Method

Endpoint

Description

GET

/contacts

List contacts with pagination

POST

/contacts

Create or upsert a contact by phone

GET

/contacts/{id}

Retrieve a contact by ID

PUT

/contacts/{id}

Update contact fields and tags

DELETE

/contacts/{id}

Delete a contact

Create a contact

bash

curl -X POST "https://api.buzzbip.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+21612345678",
    "firstName": "Walid",
    "lastName": "Ben Ali",
    "email": "[email protected]",
    "tags": ["vip", "woocommerce"]
  }'

Field

Type

Required

Description

phone

string

Yes

E.164 phone number (e.g. +21612345678)

firstName

string

Contact first name

lastName

string

Contact last name

string

Contact email address

Contacts API

Endpoints

Create a contact

Request body fields

Update a contact

Upsert behavior

Need help with your integration?

Contacts API

Endpoints

Create a contact

Request body fields

Update a contact

Upsert behavior

Need help with your integration?