Skip to main content
PATCH
cURL

Overview

Rename a list or change who can view and edit it. Include the properties you want to change. Omitted properties keep their existing values.

Examples

Set UNIFY_API_KEY to your API key. Replace the example IDs with records from your workspace. This request gives other workspace members view access to an existing list:
To let teammates also edit it, use ALL_OTHERS_CAN_EDIT. To rename the list, include name in the same request. List names must be unique in the workspace.The caller must have manage access to the list. The response returns the updated list in data.

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. At least one property must be provided. Omitted properties remain unchanged.

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 named collection of records of one object.