Project Fields

Create project field

Create a new project field.

post/v0/project_fields

Request

  • Base URL
    https://api.gem.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.gem.com/v0/project_fields
  • Auth
    none declared

Request body

namestring required

The name of the project field to create. Must differ from existing project field names.

field_type'text' | 'single_select' | 'multi_select' required

The type of the project field. Options are text, single_select, or multi_select.

optionsstring[]

The options of the project field.Only applicable when value_type is one of (single_select, multi_select).

is_requiredboolean nullable

Response

Created

idstring ObjectID
namestring required

The name of the project field.

field_type'text' | 'single_select' | 'multi_select' required

The type of the project field. Options are text, single_select, or multi_select.

user_idstring ObjectID required

The user id of the admin creating the project field.

is_requiredboolean
is_hiddenboolean

When is_hidden is true, project fields are not displayed in the Gem product, nor are they returned when making a query on the Projects endpoint.

Changes

No recorded changes to this operation across all 1 revision of this API.