Skip to contentSkip to navigation

Update Lead Field

Change a lead field's type, options, order or name.

PATCH /api/v1/lead-fields/{key}

key is the field's current name, URL-encoded. A key that leads carry without a definition gets one here. A new key renames the field on every lead in the workspace; renaming onto a name that already exists returns 409. Changing the type does not convert stored values.

Path Parameters

key string path required

The field's current name.

Request Body

key string body
New name, same rules as on create.
type string body
text, number, date, url or select.
options string[] body
Choices for select.
position integer body
Order in forms and Settings.

Response

data object
Field object
id string
Field id, or null for a key leads carry without a definition.
key string
The key in each lead's customFields.
type string
text, number, date, url or select.
options string[]
Choices of a select field; empty for other types.
position integer
Order in forms and Settings; null when not defined.
defined boolean
false for a key found on leads that nobody defined yet (treated as text).
leadCount integer
Leads with a non-empty value.

Rate Limit

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?