Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Custom Field Options

Create a custom field option

Adds a new option to a LIST type custom field.

Not permitted for FREE_TEXT custom fields or custom fields created by accounting integrations.

post/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options

Path parameters

client_idinteger required
Example:123

The ID of the business.

custom_field_idstring uuid required
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

The ID of the custom field.

Request body

textstring required

The display text for this option.

Example request

{
  "text": "Project Alpha"
}

Response

Created

idstring uuid

The unique identifier for this option.

textstring

The display text of this option.

enabledboolean

Whether this option is available for selection.

createdstring date-time

The date and time when this option was created.

updatedstring date-time

The date and time when this option was last updated.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "text": "Project Alpha",
  "enabled": true,
  "created": "2024-01-15T09:00:00Z",
  "updated": "2024-01-15T09:00:00Z"
}