Skip to main content
POST
Add existing contacts to a list (by id)

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

listId
string
required

24-character hex id of the list (from GET /business/lists).

Body

application/json
contactIds
string[]
required

Contact ids (24-character hex, 1-5000 per call) to add to or remove from the list; ids already in the list are ignored on add.

Required array length: 1 - 5000 elements

24-character hex id of a contact (the row id from GET /business/lists/{listId}/rows).

Response

Success

submittedCount
integer
required
addedCount
integer
required