Create List

Create a new marketing list for subscriber management.

Method

POST /v1/comms/lists

Headers

Authorization · string · required

Bearer token (requires comms:write).

Content-Type · string · required

application/json

Body Parameters

name · string · required

Name of the list (max 255 characters).

description · string

Optional description (max 1000 characters).

source · string

Source of the list: manual, import, signup_form, api. Defaults to manual.

doubleOptIn · boolean

Enable double opt-in for new subscribers. Defaults to false.

Request Example

cURL

curl -X POST "https://api.voyantcloud.com/v1/comms/lists" \
  -H "Authorization: Bearer $VOYANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Newsletter Subscribers",
    "description": "Main newsletter list",
    "doubleOptIn": true
  }'

Response Example

201 Created

{
  "id": "lists_01J0CBFPXW7SP2N8A9Q7T2048Q",
  "workspace_id": "workspaces_01HZYPM2QF2R8X9SZQ0J9SYBCN",
  "name": "Newsletter Subscribers",
  "description": "Main newsletter list",
  "source": "manual",
  "double_opt_in": true,
  "member_count": 0,
  "created_at": "2025-01-08T10:22:31.000Z",
  "updated_at": "2025-01-08T10:22:31.000Z"
}