v2

latestOpenAPI 3.1.02026-08-07750280.6 KB

Contact Lists

Remove contacts from a contact list

Remove contacts from a contact list by contact ID and/or phone number.

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

Contacts not currently in the list are silently ignored (idempotent).
Phone numbers that cannot be resolved to a contact in your organisation are
reported in ``not_found_phone_numbers`` without raising an error.

**Note:** This operation removes contacts from the list only.
Contacts are never deleted from your organisation.

Authentication:
- API key with READ_WRITE permission

delete/contact-lists/{contact_list_id}/contacts

Path parameters

contact_list_idstring uuid required

Request body

contact_idsstring[] nullable

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

phone_numbersstring[] nullable

List of phone numbers in E.164 format to remove from the list (max 500 per request)

Response

Contacts removed successfully

{"stackTrail":"paths:/contact-lists/{contact_list_id}/contacts:delete:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","title":"Response Remove Contacts From List Contact Lists Contact List Id Contacts Delete"}