Sign in
Lists

Create a list

Creates a list for your application. Lists are typed collections of values (domains, TLDs, or email addresses) that can be referenced by rules using the in_list condition operator.

The list's type is set at creation and cannot be changed.

post/v3/lists

Request body

namestring required
descriptionstring
type'domain' | 'tld' | 'address' required

The kind of values the list holds. Immutable after creation.

Example request

{
  "name": "Blocked domains",
  "description": "Domains we've identified as sending unwanted mail.",
  "type": "domain"
}

Response

Created

request_idstring

ID of the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": {
    "id": "d1e2f3a4-5678-4abc-9def-0123456789ab",
    "name": "Blocked domains",
    "description": "Domains we've identified as sending unwanted mail.",
    "type": "domain",
    "items_count": 42,
    "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
    "organization_id": "org-abc123",
    "created_at": 1742932766,
    "updated_at": 1742932766
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.