Sign in

v2

latestOpenAPI 3.1.02026-08-07750280.6 KB
Contact Lists

Add contacts to a contact list

Add contacts to a contact list by contact ID and/or phone number.

At least one of ``contact_ids`` or ``phone_numbers`` is required.

**Phone number resolution:**
Each phone number is matched to an existing contact in your organisation.
- ``auto_create=false`` (default): unrecognised numbers are reported in
  ``not_found_phone_numbers`` and no error is raised.
- ``auto_create=true``: unrecognised numbers are used to create new contacts
  automatically. The new contact's ``first_name`` is set to the phone number string.
  The newly created contact IDs are reported in ``created_contact_ids``.

Contacts already in the list are counted silently (idempotent operation).
``added_count`` reflects only newly added contacts.

Authentication:
- API key with READ_WRITE permission
post/contact-lists/{contact_list_id}/contacts

Path parameters

contact_list_idstring uuid required

Request body

contact_idsstring[] nullable

List of contact UUIDs to add to the list (max 500 per request)

phone_numbersstring[] nullable

List of phone numbers in E.164 format to add to the list (max 500 per request). Each number is resolved to an existing contact in your organisation.

auto_createboolean

When True, phone numbers that do not match any existing contact are automatically created as new contacts (first_name set to the phone number). When False, unrecognised phone numbers are reported in not_found_phone_numbers without raising an error.

Response

Contacts added successfully

{"stackTrail":"paths:/contact-lists/{contact_list_id}/contacts:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","title":"Response Add Contacts To List Contact Lists Contact List Id Contacts Post"}