Docs

Check whether a custom variable exists

Guide: Lists & contacts
GET
/lists/custom-variable/check

Tells whether a name is already taken for a schema, either by one of your custom variables (reason: custom_variable) or by a standard field (lead_field or company_field). The name is normalized with the same rule as the creation route and the normalized technicalName is returned.

Authorization

apiKey
Authorization<token>

Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.

In: header

Query Parameters

technicalName*string

Name to check.

schema*string

lead for contact variables, company for company variables.

Value in

  • "lead"
  • "company"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/lists/custom-variable/check?technicalName=industryFocus&schema=lead" \  -H "Authorization: YOUR_API_KEY"

{  "exists": false,  "technicalName": "icebreaker"}

POSTCreate a custom variable

Declares a custom variable on the account, so that contact keys with this name (technical or display name) land in it instead of being guessed.

GETGet the status of an export

Returns the progress of an asynchronous export started with POST /lists/list/export and async: true.