Custom Fields

Update a custom field

Updates a custom field label (see Create a custom field for more information on labels). Note that the key will change but the name remains the same when the label is updated.<br/><br/><strong>Warning: </strong>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/v4/custom_fields/{id}

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/custom_fields/{id}
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Path parameters

idinteger required

Request body

labelstring required

Response

Updates the custom field and returns its details

Changes

No recorded changes to this operation across all 2 revisions of this API.