Skip to main content
POST
/
v2
/
fields
curl --request POST \
  --url https://pub-api.conversion.ai/api/v2/fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "label": "Lead Score",
  "objectType": "CONTACT",
  "dataType": "NUMBER"
}
'
{
  "data": {
    "field": {
      "key": "lead_score",
      "label": "Lead Score",
      "objectType": "CONTACT",
      "dataType": "NUMBER"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.

Body

application/json
​
label
string
required

The human-readable display name of the field.

Example:

"Lead Score"

​
objectType
enum<string>
required

The object the field belongs to (case-insensitive). An unsupported value returns an invalid_object_type error.

Available options:
CONTACT,
COMPANY,
OPPORTUNITY,
CAMPAIGN_MEMBER
​
dataType
enum<string>
required

The data type of the field's value (case-insensitive).

Available options:
STRING,
NUMBER,
BOOLEAN,
DATE,
DATETIME
​
key
string

The field key used in the fields and companyFields maps of other endpoints. Optional — derived from label when omitted.

Must be unique across your account's fields: creating a field with a key that already exists returns a 400 invalid_field error.

Example:

"lead_score"

Response

Field created successfully.

​
data
object