Update a custom field

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

{
  "custom_field": {
    "id": 25,
    "name": "ck_field_25_last_name",
    "key": "last_name",
    "label": "Last name"
  }
}

Custom Fields

Update a custom field

Updates a custom field label (see Create a custom field above for more information on labels). Note that the key will change but the name remains the same when the label is updated.

Warning: An update to a custom field will break all of the liquid personalization tags in emails that reference it - e.g. if you update a Zip_Code custom field to Post_Code, all liquid tags referencing {{ subscriber.Zip_Code }} would no longer work and need to be replaced with {{ subscriber.Post_Code }}.

PUT

custom_fields

{id}

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

{
  "custom_field": {
    "id": 25,
    "name": "ck_field_25_last_name",
    "key": "last_name",
    "label": "Last name"
  }
}

Authorizations

X-Kit-Api-Key

string

header

required

Authenticate API requests via an API Key

Path Parameters

integer

required

Body

application/json

label

string

required

Response

Updates the custom field and returns its details

custom_field

object

required

Show child attributes

Create a custom field Delete custom field

⌘I

Getting started

Guides

Endpoints

Update a custom field

Authorizations

Path Parameters

Body

Response