Skip to main content

POST /contacts

Creates a new contact.

Required Parameters

ParameterTypeDescription
identifierStringThe identifier of the contact (e.g. phone number in WhatsApp)
sourceSourceThe source of the contact (e.g. whatsapp)
nameStringThe name of the contact

Optional Parameters

ParameterTypeDescription
tagsString[]A list of comma-separated values (e.g ['Call back', 'Interested'])
custom_fieldsString{}An object with the custom fields (e.g. {'Billing Address': 'Main Street 1})
assigned_userStringEmail of the user that you want to assign to a contact
caution

When passing custom_fields or tags make sure that they exist in your account. See tags and custom_fields in your settings. Same applies for assigned_user, must be a valid email of a user in your account.

Example Request

curl -X POST "https://api.callbell.eu/v1/contacts/414a6d692bd645ed803f2e7ce360d4c8" \
-H "Authorization: Bearer test_gshuPaZoeEG6ovbc8M79w0QyM" \
-H "Content-Type: application/json"
-d '{
"source": "whatsapp",
"identifier": "123456789",
"name": "John Doe"
}'

Response

ParameterTypeDescription
contactContactThe contact which was created.

Example Response

response.json
{
"contact": [
{
"uuid": "414a6d692bd645ed803f2e7ce360d4c8",
"name": "John Doe",
"phoneNumber": "123456789",
"avatarUrl": null,
"createdAt": "2020-11-13T21:08:53Z",
"source": "whatsapp",
"href": "https://dash.callbell.eu/contacts/414a6d692bd645ed803f2e7ce360d4c8",
"tags": [],
"assignedUser": null,
"customFields": {}
}
]
}