Create a custom field

Create a custom field for your account. The label field must be unique to your account. Whitespace will be removed from the beginning and the end of your label.

Additionally, a key field and a name field will be generated for you. The key is an ASCII-only, lowercased, underscored representation of your label. This key must be unique to your account. Keys are used in personalization tags in sequences and broadcasts. Names are unique identifiers for use in the HTML of custom forms. They are made up of a combination of ID and the key of the custom field prefixed with “ck_field”.

POST

custom_fields

curl --request POST \
  --url https://api.kit.com/v4/custom_fields \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '{
  "label": "Interests"
}'

{
  "custom_field": {
    "id": 1407,
    "name": "ck_field_1407_interests",
    "key": "interests",
    "label": "Interests"
  }
}

Authorizations

X-Kit-Api-Key

string

header

required

Authenticate API requests via an API Key

Body

application/json

Response

200

application/json

Returns a 200 and the custom field if it already exists

The response is of type object.

curl --request POST \
  --url https://api.kit.com/v4/custom_fields \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '{
  "label": "Interests"
}'

{
  "custom_field": {
    "id": 1407,
    "name": "ck_field_1407_interests",
    "key": "interests",
    "label": "Interests"
  }
}

Create a custom field

POST

custom_fields

curl --request POST \
  --url https://api.kit.com/v4/custom_fields \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '{
  "label": "Interests"
}'

{
  "custom_field": {
    "id": 1407,
    "name": "ck_field_1407_interests",
    "key": "interests",
    "label": "Interests"
  }
}

Authorizations

X-Kit-Api-Key

string

header

required

Authenticate API requests via an API Key

Body

application/json

Response

200

application/json

Returns a 200 and the custom field if it already exists

The response is of type object.

curl --request POST \
  --url https://api.kit.com/v4/custom_fields \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '{
  "label": "Interests"
}'

{
  "custom_field": {
    "id": 1407,
    "name": "ck_field_1407_interests",
    "key": "interests",
    "label": "Interests"
  }
}

Create a custom field

Authorizations

Body

Response

Getting started

Guides

Endpoints

Create a custom field

Authorizations

Body

Response