CoCoCoCoCoCo / docs
← API reference
Mutation / jobs

deleteShiftDefinition

Delete a shift definition from the caller's tenant. Deleting one that does not exist is reported as success: false with an "id" error, not as a GraphQL error. Requires shiftDefinition:delete permission.

Arguments

idShiftDefinitionID!

TypeID (prefix "shd") of the shift definition to delete.

Returns DeleteShiftDefinitionPayload!

Scalar fields at a glance

successBoolean!
↗ View the complete DeleteShiftDefinitionPayload type

Explore in a view

Production Floor
View exact SDL
"""
Delete a shift definition from the caller's tenant. Deleting one that does not exist is reported as success: false with an "id" error, not as a GraphQL error. Requires shiftDefinition:delete permission.
"""
deleteShiftDefinition(
  """TypeID (prefix "shd") of the shift definition to delete."""
  id: ShiftDefinitionID!
): DeleteShiftDefinitionPayload! @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.