Skip to main content

UpdateStatusInput

Provides the fields and values to use when updating a status.

input UpdateStatusInput {
  id: ID!
  module: StatusModule
  name: String
  color: String
  description: String
  type: StatusType
  locksEntity: Boolean
  isDefault: Boolean
  sortOrder: Int
}

Fields​

UpdateStatusInput.id ● ID! non-null scalar​

Specifies the status to update.

UpdateStatusInput.module ● StatusModule enum​

The module of the status. Example: projects

UpdateStatusInput.name ● String scalar​

The name of the status. Example: In Progress

UpdateStatusInput.color ● String scalar​

The color of the status. In hex format, without the leading '#'. Example: 0366d6

UpdateStatusInput.description ● String scalar​

The description of the project. Maximum: 191 characters. Example: The project is currently being worked on

UpdateStatusInput.type ● StatusType enum​

The type of the status.

UpdateStatusInput.locksEntity ● Boolean scalar​

Whether reaching this status should lock the entity from edits. Only valid when type is CLOSED.

UpdateStatusInput.isDefault ● Boolean scalar​

Whether the given status should be handled as a default for new entries.

UpdateStatusInput.sortOrder ● Int scalar​

The order/placement of the status.

Member Of​

updateStatus mutation