Create a new distribution list

Create a new email distribution list by providing a list name, expiration date and an inline array of contacts. The list is owned by the authenticated user. The contacts array must contain at least one valid contact with a valid email address.

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

JSON body describing the distribution list to create, including the list name, contacts array, and optional expiration timestamp.

Request body for creating a new email distribution list. Submit as application/json with an inline contacts array and list name.

string
required

The display name for the new distribution list.

contacts
array of objects
required
length ≥ 1

The list of contacts to store in the new distribution list.

contacts*

A single contact stored within an email distribution list, containing the contact's email address and optional identifying and CRM metadata fields.

string
required

The primary email address of the contact, used as the delivery address for email campaigns. Must match a valid email format.

string | null

The given name of the contact, used in email personalization and display.

string | null

The family name or surname of the contact, used together with firstName to form a full display name.

string | null

The name of the organization the contact is associated with, used for filtering and personalization in email campaigns.

string | null

The job title of the contact within their organization, used for personalization and audience segmentation.

string | null

The CRM account identifier associated with the contact's organization, used to link distribution list entries back to CRM records.

date-time | null

The UTC timestamp indicating when this distribution list should expire. Omit or set to null for a list that will expire in a year.

Headers
integer
≤ 10485760
Defaults to 10485760

Maximum allowed request body size is 10 MB.

Responses

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