Skip to main content

​
Method

PATCH /v1/comms/lists/:id

​
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

​
name
string
Updated name (max 255 characters).
​
description
string
Updated description (max 1000 characters). Pass null to clear.
​
doubleOptIn
boolean
Update double opt-in setting.

​
Request Example

curl -X PATCH "https://api.voyantcloud.com/v1/comms/lists/lists_01J0CBFPXW7SP2N8A9Q7T2048Q" \
  -H "Authorization: Bearer $VOYANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Newsletter",
    "description": "Updated description"
  }'

​
Response Example

{
  "id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "workspace_id": "workspaces_01HZYPM2QF2R8X9SZQ0J9SYBCN",
  "name": "Weekly Newsletter",
  "description": "Updated description",
  "source": "signup_form",
  "double_opt_in": true,
  "member_count": 1523,
  "created_at": "2025-01-08T10:22:31.000Z",
  "updated_at": "2025-02-02T15:30:00.000Z"
}