Sign in
Custom Fields

Update custom field

Update an existing custom field definition. applies_to and company_ids are replaced wholesale — send the full desired list. field_type cannot be changed after creation.

put/public/v1/custom-fields/{custom_field_id}/

Path parameters

custom_field_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
company_idinteger nullable

Single company id this custom field is scoped to (merged into company_ids). Omit for an org-wide field.

company_idsinteger[] nullable

List of company ids this custom field is scoped to. Omit for an org-wide field.

is_activeboolean
optionsstring[] nullable

Allowed values for single_select / multi_select fields

Response

OK

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
company_idinteger nullable
company_idsinteger[]
namestring required
descriptionstring nullable
helper_textstring nullable
field_type'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph' required
optionsstring[] nullable
is_activeboolean required

Changes

Changed in 2 of the 27 revisions of this API.3

  • d0cd912ee42d2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af0ec77e52771See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

Of the 27 revisions, 1 has no diff computed.