Skip to main content

​
Method

PATCH /v1/comms/lists/:id/members/:memberId

​
Path Parameters

​
id
string
required
The list ID.
​
memberId
string
required
The member ID.

​
Headers

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

​
Body Parameters

​
status
string
required
New status: subscribed, unsubscribed, cleaned, bounced.

​
Request Example

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

​
Response Example

{
  "id": "list_members_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "list_id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "person_id": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
  "status": "unsubscribed",
  "source": "api",
  "subscribed_at": "2025-01-08T10:22:31.000Z",
  "unsubscribed_at": "2025-02-15T09:00:00.000Z",
  "created_at": "2025-01-08T10:22:31.000Z",
  "person": null
}
When setting status to unsubscribed, the unsubscribed_at timestamp is automatically set. Members with non-subscribed status will not receive marketing campaigns.