Sign in
ClientListApiAgentResource

Change the title or description of a client list

Changes title and desc of a list; the fields you omit keep their value. Lists that Sumsub maintains cannot be changed.

patch/resources/api/agent/clientLists

Request body

descstring

New description. Omit it to keep the current one.

idstring required
titlestring

New display title. Omit it to keep the current one.

Example request

{
  "title": "High risk countries"
}

Response

default response

createdAtstring date-time

When the list was created.

descstring

Free-text description of the list.

entryTypestring

Kind of key the list holds.

idstring
namestring

Name that rules reference the list by, as clientLists.<name>.

titlestring

Display title of the list.

typestring

Purpose of the list: custom, blocklist, whitelist, or system for lists that Sumsub maintains.

Example response

{
  "name": "high_risk_countries",
  "title": "High risk countries"
}

Changes

Changed in 1 of the 39 revisions of this API.1