Project fields

Create project field

Changed on

Create a project field with optional starting options. An organization can have up to 20 project fields, and creating one more fails with 422. Requires the organization admin role.

post/v1/organizations/{organizationId}/project-fields/

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

Path parameters

organizationIdstring required

Request body

namestring required
optionPolicy'open' | 'closed' required

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' required

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

mode'required' | 'optional' required

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

optionsstring[]

Starting options. Duplicates are ignored, comparing values case-insensitively.

Response

Default Response

Changes