v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Custom Object Fields

Update Custom Object Field

Updates individual custom object fields. The updating rules are as follows:

  • Takes a custom_object_field object that specifies the properties to update
  • The key property cannot be updated
  • If updating a standard field, only the title, description, and properties attributes can be updated.
  • The properties parameter is comprised of four parts and can't be changed if any records exist for the object.
    • autoincrement_enabled: A Boolean that enables and disables autonumbering. Must be false if is_unique is true.
    • autoincrement_prefix: A string value that is used as a prefix to the autogenerated numbers. It can't exceed 30 characters.
    • autoincrement_padding: An integer specifying the starting number of digits in the autogenerated numbers. This value may be between 0-9. However, if you create records in excess of of these digits, additional digits are added as necessary.
    • autoincrement_next_sequence: An integer that will be used as the next number in the autonumbering sequence. It can't be negative or less than the current autonumbering value.
    • is_unique: A Boolean that enforces uniqueness for manually entered record names. When true, custom object record names must be unique. Must be false if autoincrement_enabled is true.

Allowed For

  • Admins
patch/api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}

Path parameters

custom_object_keystring required

The key of a custom object

custom_object_field_key_or_idstring required

The key or id of a custom object field

Response

Success response