Be notified when contact creation via the Contacts API has been completed.
Callback is requested via API Contacts POST
To receive this notification, provide a URL against the callback_url parmeter when making the request to create contacts.
Events
| Event | Description |
|---|---|
| Contact creation is complete | Triggered when all contacts that were requested for creation via the Contacts API have been processed. |
Payload Sample
{
"timestamp": "2025-08-01T10:50:40Z",
"results": {
"total_contacts_failed": "0",
"total_contacts_imported": "2",
"total_contacts_merged": "0"
},
"list_id": "LST_2eAVchPopgQmTpBOUKEJBM8d2IL",
"list_name": "list 2",
"correlation_id": "correlation_sample_uid_1203587617"
}
Field Definitions
| Parameter | Description |
|---|---|
| timestamp | The date time that the contact creation job completed. |
| total_contacts_failed | A count of contacts that failed to be created. |
| total_contacts_imported | A count of new contacts that were successfully created. |
| total_contacts_merged | A count of existing contacts that were updated. Note that a merge will occur in case the API Contacts POST merge_type is set to mergeByPhoneNumberInList or mergeByWhatsappIdInList and the respective number already exists against a contact. |
| list_id | The list id for the updated list. |
| list_name | The list name for the updated list. |
| correlation_id | The correlation id that was given on the API Contacts POST request. |