← API reference
Mutation / surfaces

publishJourney

Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.

Arguments

TypeID of the journey to publish (prefix jny).

TypeID of the draft version to promote (prefix jnv). Fails with a field error when the version is unknown, belongs to another journey, or is not an open draft.

Returns JourneyPayload!

Explore in a view

Journeys and Workspaces
View exact SDL
"""
Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.
"""
publishJourney(
  """TypeID of the journey to publish (prefix `jny`)."""
  id: JourneyID!
  """
  TypeID of the draft version to promote (prefix `jnv`). Fails with a field error when the version is unknown, belongs to another journey, or is not an open draft.
  """
  versionId: JourneyVersionID!
): JourneyPayload! @topic(names: ["surfaces"])

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