Update a custom list

post

https://sandbox-api.coris.ai/api/v0_2/settings/custom_list/{list_id}/

Changes a custom list. Only the fields you send change, and items replaces the whole list, so read it first with Get a custom list. This call does not check items, so send an array of strings or numbers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

list_id

uuid

required

The ID of the custom list, as a UUID.

Body Params

Custom List update request

name

string

The name of the list, unique in your workspace.

description

string

What the list is for.

list_type

string

enum

What the list holds.

keyword_screening: keywords to screen for.
account_ids: account IDs.
account_names: account names.
mcc_codes: MCC codes.
naics_codes: NAICS codes.
adverse_media_keywords: keywords for adverse media checks.
negative_review_keywords: keywords for negative review checks.
topic_screening: topics to screen for.

items

array

The items in the list: strings or numbers.

items

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

list_type is unknown. Read the plain-text body and fix the field.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200The list was updated.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403The key's user does not have access to manage custom lists. Ask Coris support. A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

404No item has this ID in your workspace. Check the ID and the environment.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500A list already has this name. Choose another name, or read your lists and reuse the match.