Skip to main content
PATCH
curl
Update the name or description of a list. Any other field in the body is ignored, so list_type and entry_type keep the values they were created with. System lists cannot be modified and return 400. The response contains only name and description. Call Get list for the full list.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

list_uuid
string<uuid>
required

UUID of the list, as returned by List lists or Create a list.

Body

application/json
name
string

New name. Must differ from the name of every other list of the application.

Required string length: 1 - 255
description
string

New description. Send an empty string to clear it.

Response

The list was updated. Only the editable fields are returned.

name
string
required

The list's name after the update.

description
string
required

The list's description after the update.