Skip to content
Brooklyn Solutions Developers

Custom fields

Extra fields administrators add to records.

Base path
/customfield

Endpoints

11 endpoints

Method

Standard Operations

7
  • GET /customfield List custom fields (with search, filters and paging).
  • POST /customfield Create a new custom field.
  • PATCH /customfield/bulk Update several custom fields at once.
  • GET /customfield/{id} Open a single custom field.
  • PUT /customfield/{id} Replace a custom field's details in full.
  • PATCH /customfield/{id} Edit a custom field.
  • DELETE /customfield/{id} Delete a custom field.

Additional Operations

4
  • POST /customfield/csv Download the custom fields list as a spreadsheet.
  • GET /customfield/{id}/check-max-length Check the longest value stored in a custom field (before shortening it).
  • PATCH /customfield/value/{entityType}/{valueRecordId} Change a custom field value on a record.
  • GET /customfield/{entityName}/{entityId} Show the custom field values on a record.