Update a distribution list

Update an existing email distribution list by providing a new name, a new contacts array, or an updated expiration timestamp. If contacts are provided, the existing list contacts are replaced with the supplied collection; if contacts are omitted, the existing contacts remain unchanged. Only the list owner may update a list.

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

The GUID of the distribution list.

Body Params

JSON body for updating the distribution list, including a new name, a required complete contacts array, and an optional expiration timestamp.

Request body for updating an existing distribution list. Provide a new name and a replacement contacts array, and an optional expiration timestamp.

string
required

The new display name for the distribution list.

contacts
array of objects
required
length ≥ 1

A new list of contacts that replaces all existing contacts when provided.

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 when the distribution list expires. Set to null to clear an existing expiry.

Responses

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