Project fields

Update project field

Changed on

Change the name or settings of a project field. Properties left out are not changed. Switching cardinality to single keeps existing project values that have more than one option. Requires the organization admin role.

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

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}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

organizationIdstring required
fieldIdstring required

Request body

namestring
optionPolicy'open' | 'closed'

Who can add options. open lets any organization member add options while filling in a project. closed lets only organization admins add options.

cardinality'single' | 'multiple'

How many options a project can have for this field. single allows one, multiple allows one or more.

mode'required' | 'optional'

Whether projects must fill in this field. A required field must have at least one option whenever field values are set on a project.

Response

Default Response

Changes