Skip to main content
Comprehensive domain and email block list management GET retrieves paginated block list with filtering by client assignment and search terms

Overview

Comprehensive domain and email block list management Key Features:
  • Returns blocked entries with: email/domain, source (manual/bounce/spam), creation date, client association

Get Domain Block List

GET /v1/leads/get-domain-block-list

Retrieves entries from your domain block list with pagination. Query Parameters:
  • api_key (required): Your API key
  • offset (optional, default: 0): Pagination offset
  • limit (optional, default: 100, max: 1000): Number of records
  • filter_client_id (optional): Filter by client ID
  • filter_email_or_domain (optional): Search by email or domain name
  • filter_email_with_domain (optional): Search by email with domain

Response Codes

Success
Request successful
Bad Request
Invalid request parameters or malformed request body
Unauthorized
Invalid or missing API key. Check your authentication.
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.

Add to Block List

POST /v1/leads/add-domain-block-list

Adds domains or email addresses to the global block list. Query Parameters:
  • api_key (required): Your API key
Request Body:
  • domain_block_list (required): Array of domains/emails to block
  • client_id (optional): Associate with specific client

Response Codes

Success
Request successful
Bad Request
Invalid request parameters or malformed request body
Unauthorized
Invalid or missing API key. Check your authentication.
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.

Delete from Block List

DELETE /v1/leads/delete-domain-block-list

Removes an entry from the block list. Query Parameters:
  • api_key (required): Your API key
  • id (required): ID of the block list entry to delete

Response Codes

Success
Request successful
Bad Request
Invalid request parameters or malformed request body
Unauthorized
Invalid or missing API key. Check your authentication.
Not Found
The requested resource (campaign, lead, email account, etc.) does not exist or you don’t have access to it
Validation Error
Request validation failed. Check parameter types, required fields, and value constraints.
Rate Limit Exceeded
Too many requests. Please slow down and retry after the rate limit resets.
Internal Server Error
Server error occurred. Please try again or contact support if the issue persists.
Service Unavailable
API is temporarily unavailable or under maintenance. Please try again later.