Create a custom list

post

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

Creates a named list, such as keywords or MCC codes, that your monitoring can use. name must be unique in your workspace. To change a list, use Update a custom list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Custom List creation request

name

string

required

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

required

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

name or items is missing, a list has this name, an item is not a string or number, or 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

201The list was created.

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.

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.

500Coris could not complete the request. Retry with backoff. If it continues, contact support.