Skip to main content
PATCH
Update Contact List

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

contact_list_id
string<uuid>
required

ID of the contact list.

Body

application/json

Update Contact List payload

name
string | null

New name for the list.

Minimum string length: 1
default_sequence_template_id
string<uuid> | null

New default sequence template. Pass null to clear.

Response

200 - application/json

Successful Response

id
string<uuid>
required

Unique identifier.

name
string | null
required

Name of the list.

default_sequence_template_id
string<uuid> | null
required

Default sequence template for new entries.

entries_count
integer
required

Current number of entries in the list.

created_at
string<date-time>
required

When the list was created.

updated_at
string<date-time>
required

When the list last changed.

default_sequence_template
PublicSequenceTemplateSummary · object | null

Summary of the default sequence template for new entries.