Articles on: API Documentation

Manage Your Contacts Using REST API

If you want to add contacts from 3rd party websites, apps or using automation tools like Zapier or Pabbly, you can use our API to do so.

View our full REST API Postman collection here

Note: This is an advanced feature so you might need help of your developer to set this up for you if you’re not familiar with using REST API and webhooks.

Follow the steps below to add contacts using this API feature:

Open the Contacts > Import / Export page and scroll down to the Add contacts using API request section.
There you’ll see two fields:

Webhook URL – this is your unique webhook URL where you need to send POST request from your website, app or automation tool with your contact data.
Webhook Request Example Data – this is the exact JSON format in which you need to send the POST request with your contact data. Make sure to keep Content-Type as application/json in your request.

Once you send the request the contact will be automatically added to your contacts. If the contact already exists, it’ll be updated with the new data that you send.

That’s all. It’s as simple as we could have made it. 🙂

Webhook Request Data Format:

{
    "whatsapp_number": "+919876543210",
    "first_name": "John",
    "last_name": "Doe",
    "attributes": {
        "custom_attribute_1": "Value 1",
        "custom_attribute_2": "Value 2",
        "custom_attribute_3": "Value 3"
    },
    "lists": [
        "Default"
    ],
    "tags": [
        "new lead",
        "notification sent"
    ],
    "status": "subscribed",
    "replace": false
}

Field	Description
`whatsapp_number`	WhatsApp phone number of the contact with country extension. string / required
`first_name`	First name of the contact. string / optional
`last_name`	Last name of the contact. string / optional
`attributes`	Contact attributes.
`custom_attribute_1`, `custom_attribute_2` and so on	Key value pair of your custom attributes. array of key-value pairs / optional
`status`	Can be either subscribed or unsubscribed. strings / optional
`lists`	List names. array of strings / optional
`tags`	Tags. array of strings / optional
`replace`	Keep this value true to replace existing custom attributes, lists and tags with data sent in the request. Else, keep false. boolean / optional

Updated on: 10/04/2025

Was this article helpful?

Thank you!