โ† API reference
Mutation / surfaces

deleteWorkspace

Delete a workspace and all its versions. Owner for PERSONAL, else workspace:write.

Arguments

TypeID of the workspace to delete (prefix wks). Its versions and team assignments cascade.

Returns DeletePayload!

Scalar fields at a glance

successBoolean!
โ†— View the complete DeletePayload type

Explore in a view

Journeys and Workspaces
View exact SDL
"""
Delete a workspace and all its versions. Owner for PERSONAL, else workspace:write.
"""
deleteWorkspace(
  """
  TypeID of the workspace to delete (prefix `wks`). Its versions and team assignments cascade.
  """
  id: WorkspaceID!
): DeletePayload! @topic(names: ["surfaces"])

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