Sign in
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

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/contact-lists/{contact_list_id}/contacts
  • Auth: API Key (a scheme the document does not define)

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

unknown required

Changes

No recorded changes to this endpoint across all 8 revisions of this API.