Update Field Definition

Updates an existing Custom Field Definition with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.

See Extensibility for more information.

Roles

To call this endpoint, you must have one of these roles:

  • Group Owner
  • Group Admin

You can view your roles with the Status API.

Data Definition

See CustomFieldDefinitionModel for the complete data definition.

Language
Authentication
URL
Click Try It! to start a request and see the response here!