Lists

Add Contacts To List

Add contacts to a list by their IDs.

added is the number of membership rows really created. Ids that are not live contacts in this org come back in not_found; ids already on the list in already_member (LI-01). A missing or deleted list is a 404.

post/lists/{list_id}/contacts

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/lists/{list_id}/contacts
  • Auth: HTTP bearer

Path parameters

list_idinteger required

List ID

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

contact_idsinteger[] required

List of contact IDs to add

conflict_resolution'add_all' | 'skip_all' | 'custom' nullable

Required on retry after a 409 CONFLICT_REVIEW_REQUIRED response: 'add_all' adds ready + every warned contact, 'skip_all' adds only ready contacts, 'custom' adds ready + the ids in include_warned_ids. Blocked contacts are always excluded regardless of this value.

include_warned_idsstring[] nullable

With conflict_resolution='custom', the warned contact ids to also add.

Response

Successful Response

dataobject required

Changes

No recorded changes to this operation across all 2 revisions of this API.