COconnecteam
Users:v1:Custom Fields:Custom Field options

Update custom field option

Update the value for an option under a specified custom field

put/users/v1/custom-fields/{customFieldId}/options/{optionId}

Request

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

Path parameters

optionIdinteger required

The unique identifier of the option to update

customFieldIdinteger required

The unique identifier of the custom field

Request body

valuestring

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.