Skip to main content
POST
Create data list

Overview

Creates a new data list for the organization. Use type: "custom" for a generic list you will reference by UUID in rules.

Endpoint

Authentication

Request Body

string
required
Display name (1–200 characters). Shown in the dashboard (list catalog, selectors, headers) so your team can identify the list; it does not affect how rules match items.
string
required
List type enum, including custom, company_blocklist, document_blocklist, keyword_list, ip_blocklist, and others supported by the platform.
string
Optional description (max 1000 characters). Use for internal context (owner, refresh policy, intended use case); visible in the dashboard where the product shows list details. Not used by the matching engine.
string
required
Origin of data, e.g. manual_entry, api_integration, custom_upload, internal, etc.
object
Optional: autoSync, syncFrequency, externalUrl, apiKey, visibleItemDataColumns, etc.
object
Optional string-to-string map for ingestion mappings.
number
default:"50"
Priority 1–100.
boolean
Reserved for platform use; tenant clients normally omit or set false.

Example

Response

201 with success, data (includes list id), and timing metadata on success.