Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

list_id
string
required

ID of the list. String UUIDv4 value.

Body

application/json

Request body for updating a list. Only the properties present are changed; at least one must be provided. The list's object and owner_id cannot be changed.

name
string

New name for the list. Must be unique within the workspace.

Required string length: 1 - 255
share_status
enum<string>

Who can see and change the list.

Available options:
ONLY_ME,
ALL_OTHERS_CAN_VIEW,
ALL_OTHERS_CAN_EDIT

Response

Response for a successful update operation.

Response for a successful update operation.

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

A list is a named, hand-curated set of records of a single object, for example a set of company records to target this quarter. Lists are owned by a user and shared according to share_status.