Delete project label

deleteProjectLabel(input: DeleteProjectLabelInput!): DeleteProjectLabelPayload!

Requires project.settings.manage; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteProjectLabelInput!Yes

Input fields

input

DeleteProjectLabelInput

FieldTypeRequiredDescription
projectReferenceString!YesProject UUID or slug.
labelIdID!YesActive label to soft-delete in the selected project. A missing or already deleted label returns not found.

Response

Returns DeleteProjectLabelPayload!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: the deletion completed. A failed deletion is a GraphQL error.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteProjectLabel($input: DeleteProjectLabelInput!) {
  deleteProjectLabel(input: $input) {
    ok
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "labelId": "00000000-0000-4000-8000-000000000001"
  }
}