Skip to main content
POST
cURL

Overview

Create a list to collect records for a campaign, account review, or another workflow. Each list holds records from one object. Add its members in a separate request after creating the list.

Examples

Set UNIFY_API_KEY to your API key. This creates a private person list:
Save data.id from the response, then use it to add entries. A list’s name must be unique in the workspace, and its object cannot change after creation.

Authorizations

x-api-key
string
header
required

Body

application/json

Request body for creating a list.

name
string
required

Name of the list. Must be unique within the workspace.

Required string length: 1 - 255
object
string
required

API name of the object whose records the list will hold. Cannot be changed after creation.

share_status
enum<string>

Who can see and change the list. Defaults to ONLY_ME.

Available options:
ONLY_ME,
ALL_OTHERS_CAN_VIEW,
ALL_OTHERS_CAN_EDIT

Response

Response for a successful create operation.

Response for a successful create operation.

status
enum<string>
required
Available options:
success
data
object
required

A named collection of records of one object.