Delete custom field option

The "Delete Custom Field Option" endpoint allows you to remove a specific dropdown option identified by its optionId under a specified custom field indicated by its customFieldId.

This action is critical for managing and maintaining the accuracy of dropdown options.

Key guidelines to follow for deleting a custom field option:

customFieldId: The unique identifier of the custom field. This is a path URL parameter, so make sure to include it in the request URL. Additionally, ensure that the custom field is of the 'dropdown' type.

optionId: The unique identifier of the option you want to delete. This is a path URL parameter and is required for specifying which option to remove.

CURL example for deleting a custom field option (value):

curl --request DELETE \
     --url 'https://api.connecteam.com/users/v1/custom-fields/123456/options/3' \
     --header 'X-API-KEY: 73acf336-5115-49f0-9b7b-380db8562b5d'

Payload example for the response:

{
  "requestId": "string",
  "data": {}
}