COconnecteam
Users:v1:Custom Fields:Custom Field options

Create custom field option

Add new option for a specified custom field.The option will be added to the existing ones and will not overwrite them.Currently supports dropdown custom fields options.

post/users/v1/custom-fields/{customFieldId}/options

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/users/v1/custom-fields/{customFieldId}/options
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: users.write

Path parameters

customFieldIdinteger required

The unique identifier of the custom field

Request body

valuestring required

The value to be added as the option

isDisabledboolean

Indicates if this option is disabled

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.