Project fields

Update project field option

Changed on

Rename, archive or restore a project field option. Properties left out are not changed. Renaming to a value that another option of the field already has fails with 422. Requires the organization admin role.

patch/v1/organizations/{organizationId}/project-fields/{fieldId}/options/{optionId}

Request

  • Base URL: https://api.coloop.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.coloop.ai/v1/organizations/{organizationId}/project-fields/{fieldId}/options/{optionId}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

organizationIdstring required
fieldIdstring required
optionIdstring required

Request body

valuestring

New value. Renaming changes the option on every project that uses it.

state'active' | 'archived'

Set to archived to archive the option, or active to restore it.

Response

Default Response

Changes