BlockListEntry

Patch block list entry

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

patch/api/v2/block-lists-entries/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/block-lists-entries/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-8c10-7148-afff-287e8b779711

The ID of the item to update

Request body

bl_valuestring

The email or domain to block

Example request

{
  "bl_value": "example.com"
}

Response

The updated 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": "01a19e6f-509a-7172-9a36-040da2e6dd9f",
  "timestamp_created": "2026-11-02T22:44:17.690Z",
  "organization_id": "01a19e6f-509a-7172-9a36-040e08395cbe",
  "bl_value": "example.com",
  "is_domain": true
}

Changes

No recorded changes to this operation across all 6 revisions of this API.