v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

BlockListEntry

Create block list entry

Requires one of the following scopes: block_list_entries:create, block_list_entries:all, all:create, all:all

post/api/v2/block-lists-entries

Request body

bl_valuestring required

The email or domain to block

Example request

{
  "bl_value": "example.com"
}

Response

The Block List Entry

idstring uuid required

Unique identifier for the block list entry

timestamp_createdstring date-time required

Timestamp when the block list entry was created

organization_idstring uuid required

Organization ID that owns this block list entry

bl_valuestring required

The email or domain to block

is_domainboolean required

Whether this entry blocks an entire domain

Example response

{
  "id": "019f94cd-83d7-7e6b-bfe1-49c0166cf5d5",
  "timestamp_created": "2026-07-24T15:45:24.439Z",
  "organization_id": "019f94cd-83d7-7e6b-bfe1-49c1e2ef2967",
  "bl_value": "example.com",
  "is_domain": true
}