Add Members

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"
  }'

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 '{
    "personIds": [
      "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
      "people_02ABCDE3FG4HI5JK6LM7N8O9PQ"
    ]
  }'

const listId = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"

// Add single member
const res = await fetch(
  `https://api.voyantcloud.com/v1/comms/lists/${listId}/members`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      personId: "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
    }),
  }
)

// Add multiple members
const batchRes = await fetch(
  `https://api.voyantcloud.com/v1/comms/lists/${listId}/members`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      personIds: [
        "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
        "people_02ABCDE3FG4HI5JK6LM7N8O9PQ",
      ],
    }),
  }
)

import os, requests

list_id = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"

# Add single member
resp = requests.post(
  f"https://api.voyantcloud.com/v1/comms/lists/{list_id}/members",
  json={"personId": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"},
  headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)

# Add multiple members
resp = requests.post(
  f"https://api.voyantcloud.com/v1/comms/lists/{list_id}/members",
  json={
    "personIds": [
      "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
      "people_02ABCDE3FG4HI5JK6LM7N8O9PQ",
    ]
  },
  headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)

{
  "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
}

{
  "data": {
    "added": 2
  }
}

{
  "error": "List not found"
}

Method

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

Path Parameters

string

required

The list ID.

Headers

string

required

Bearer token (requires comms:write).

string

required

application/json

Body Parameters (Single Member)

string

required

The person ID to add.

string

How the member was added: manual, import, api, form. Defaults to api when using the API.

Body Parameters (Batch Add)

string[]

required

Array of person IDs to add.

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"
  }'

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 '{
    "personIds": [
      "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
      "people_02ABCDE3FG4HI5JK6LM7N8O9PQ"
    ]
  }'

const listId = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"

// Add single member
const res = await fetch(
  `https://api.voyantcloud.com/v1/comms/lists/${listId}/members`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      personId: "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
    }),
  }
)

// Add multiple members
const batchRes = await fetch(
  `https://api.voyantcloud.com/v1/comms/lists/${listId}/members`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      personIds: [
        "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
        "people_02ABCDE3FG4HI5JK6LM7N8O9PQ",
      ],
    }),
  }
)

import os, requests

list_id = "lists_01J0CBFPXW7SP2N8A9Q7T2048Q"

# Add single member
resp = requests.post(
  f"https://api.voyantcloud.com/v1/comms/lists/{list_id}/members",
  json={"personId": "people_01HZYPM2QF2R8X9SZQ0J9SYBCN"},
  headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)

# Add multiple members
resp = requests.post(
  f"https://api.voyantcloud.com/v1/comms/lists/{list_id}/members",
  json={
    "personIds": [
      "people_01HZYPM2QF2R8X9SZQ0J9SYBCN",
      "people_02ABCDE3FG4HI5JK6LM7N8O9PQ",
    ]
  },
  headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
)

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
}

{
  "data": {
    "added": 2
  }
}

{
  "error": "List not found"
}

Use batch add (personIds) when adding multiple members for better performance. Duplicate person IDs are handled gracefully (existing members are skipped).

API overview

Bookings

Collections

Forms

People

Policies

Contracts

Communications

Marketplace

Promotions

Vouchers

Departures

Gallery

Places

Verify

Payments

Analytics

Webhooks

Products

Accommodations

Media

Transport

Lodging

Itinerary

Billing

Workspaces

Organizations

Reference Data

Method

Path Parameters

Headers

Body Parameters (Single Member)

Body Parameters (Batch Add)

Request Example

Response Example (Single)

​Method

​Path Parameters

​Headers

​Body Parameters (Single Member)

​Body Parameters (Batch Add)

​Request Example

​Response Example (Single)

Method

Path Parameters

Headers

Body Parameters (Single Member)

Body Parameters (Batch Add)

Request Example

Response Example (Single)