Create List

Creates a contact list from a JSON body or an uploaded CSV file. Returns the id used as listId by all list, segment, and contact endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You create a new list as the first step by adding contacts via JSON body or from a CSV file.

You define the columns and rows the new list will contain to set up a list. Once defined, you add one or more contacts to the list as the next step.

This endpoint lets you create a new list and add contacts in the same request.

📘

Creating List

You can generate a list in different ways:

  • From the platform. You create and use a list located in the Communications Platform.
  • From the API. You create and use a list located in the Create List API. You can also use a list located in the platform by exporting it from the Contacts section as a CSV file and importing it into the API.

You must create a list before adding contacts to it.

The Manage Lists section covers how to create a single list.

Query Params
boolean

A parameter to indicate if the list is going to track contact last activity

string

The name of the list (If using a csv file)

string

The key of the list (If using a csv file). Must be null or empty if an autogenerated key is wanted

boolean

A parameter to indicate if the list is using autogenerated columns(must be using auto generated id). True by default (If using a csv file)

boolean

A parameter to indicate if the list is using case sensitive columns. False by default (If using a csv file)

boolean

A parameter to indicate if empty unique columns are to be populated with fake data (must be using auto generated id). True by default (If using a csv file)

Body Params
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json