GEgem
Project Fields

Update project field

Update a project field with the corresponding id.

patch/v0/project_fields/{project_field_id}

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/{project_field_id}
  • Auth
    none declared

Request body

namestring

The name of the project field. Must be unique across entire team.

is_requiredboolean
is_hiddenboolean

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

Response

OK

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.