Skip to main content
POST
/
v1
/
blocklist
/
add-entities
curl --request POST \
  --url https://openapi.enginy.ai/v1/blocklist/add-entities \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "entityType": "LEAD",
  "entityIds": [
    101,
    102,
    103
  ],
  "reason": "NOT_INTERESTED"
}
'
{
  "message": "<string>",
  "data": {
    "added": 123,
    "resolvedEntities": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
entityType
enum<string>
required

Whether the supplied IDs are contact (LEAD) IDs or company (COMPANY) IDs.

Available options:
COMPANY,
LEAD
​
entityIds
integer[]
required

Entity IDs to resolve and block. Up to 500 per request.

Required array length: 1 - 500 elements
​
reason
enum<string>
required

Reason classification applied to all created entries.

Available options:
NOT_INTERESTED,
COMPETITOR,
CUSTOMER,
NOT_TARGET,
OTHER,
CHURN
​
blockTypes
enum<string>[]

Restrict which value kinds are extracted from the resolved entities. For COMPANY entities, valid kinds are DOMAIN and COMPANY_LINKEDIN_URL. For LEAD entities, valid kinds are EMAIL and LINKEDIN_URL. Omit to block every applicable value.

Available options:
DOMAIN,
COMPANY_LINKEDIN_URL,
EMAIL,
LINKEDIN_URL
​
fromLeads
boolean

Only used when entityType is COMPANY. If true, the supplied IDs are interpreted as lead IDs and the leads' parent companies are blocked instead. Defaults to false.

​
periodDays
integer

If provided, the entry expires periodDays days after creation. Omit for a permanent entry.

Response

Entities resolved and blocked

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
data
object
required