CoCoCoCoCoCo / docs
← API reference
Mutation / surfaces

updateJourney

Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.

Arguments

idJourneyID!

TypeID of the journey to patch (prefix jny). This, not the definition's handle, identifies the record; the handle is never reassigned.

inputUpdateJourneyInput!

The aspects to change. Omitted fields leave the journey untouched.

Returns JourneyPayload!

Explore in a view

Journeys and Workspaces
View exact SDL
"""
Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.
"""
updateJourney(
  """
  TypeID of the journey to patch (prefix `jny`). This, not the definition's handle, identifies the record; the handle is never reassigned.
  """
  id: JourneyID!
  """The aspects to change. Omitted fields leave the journey untouched."""
  input: UpdateJourneyInput!
): JourneyPayload! @topic(names: ["surfaces"])

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