Skip to main content

​
Method

POST /v1/comms/lists/:id/members

​
Path Parameters

​
id
string
required
The list ID.

​
Headers

​
Authorization
string
required
Bearer token (requires comms:write).
​
Content-Type
string
required
application/json

​
Body Parameters (Single Member)

​
personId
string
required
The person ID to add.
​
source
string
How the member was added: manual, import, api, form. Defaults to api when using the API.

​
Body Parameters (Batch Add)

​
personIds
string[]
required
Array of person IDs to add.
​
source
string
How the members were added. Defaults to api.

​
Request Example

curl -X POST "https://api.voyantcloud.com/v1/comms/lists/lists_01J0CBFPXW7SP2N8A9Q7T2048Q/members" \
  -H "Authorization: Bearer $VOYANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "personId": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"
  }'

​
Response Example (Single)

{
  "id": "list_members_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "list_id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "person_id": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
  "status": "subscribed",
  "source": "api",
  "subscribed_at": "2025-01-08T10:22:31.000Z",
  "unsubscribed_at": null,
  "created_at": "2025-01-08T10:22:31.000Z",
  "person": null
}
Use batch add (personIds) when adding multiple members for better performance. Duplicate person IDs are handled gracefully (existing members are skipped).