Managing Contacts via API

The Contacts API allows you to create, update, and retrieve contact information programmatically.

List Contacts

Endpoint: GET /api/v1/contacts. Returns a paginated list of all contacts. You can filter by group, status (subscribed, unsubscribed, blocked), and search by name or phone number.

Create a Contact

Endpoint: POST /api/v1/contacts. Required fields: first_name, contact_number, country_code (e.g., '+91'). Optional fields: last_name, email, group_id, tags (array of tag strings), custom_attributes (object with key-value pairs).

Update a Contact

Endpoint: PUT /api/v1/contacts/{id}. Pass any fields you want to update. Only provided fields will be modified; other fields remain unchanged.

Contact Subscription Status

Contacts can opt out of marketing messages by sending 'STOP' via WhatsApp. Their status changes to 'unsubscribed'. They can opt back in by sending 'START'. The API allows you to check a contact's subscription status and respect their preferences when sending messages.