← All types
Apps & SurfacesIn Input object

UpdateJourneyInput

Patch input for updateJourney — every field is optional and an omitted field leaves that aspect of the journey unchanged. The journey is identified by the mutation's id argument, not by this input.

Fields

Observed journey revision; when supplied, concurrent edits must match before the update is applied.

source

StringOptional

Author-owned cococo-journey-source/1 JSON envelope containing sourceXML. Compiled JSON is server-owned.

New distribution scope. Omitted leaves the journey's current scope. Moving a journey out of PERSONAL requires journey:write; a PERSONAL journey can only ever be touched by its owner.

Possible values (3)
PERSONAL

Owned by one user and visible only to them. Self-service: authoring it needs journey:personal rather than journey:write, and journey:write is not a backdoor into someone else's personal journey.

TEAM

Offered to the members of the teams it is assigned to; at least one team is required. Authoring it needs journey:write.

INSTANCE

Offered to everyone in the tenant whose permissions cover its requiredDomains. The default scope when none is given, and what bundled journeys use; authoring it needs journey:write.

teamIds

[TeamID!]Optional

Team TypeIDs (prefix tea) to assign when the resulting scope is TEAM. Patch semantics: omitting it leaves existing assignments untouched (unlike upsertJourney, which always replaces them). Each must belong to the caller's tenant.

Referenced by (1)
Exact type SDL
"""
Patch input for `updateJourney` — every field is optional and an omitted field leaves that aspect of the journey unchanged. The journey is identified by the mutation's `id` argument, not by this input.
"""
input UpdateJourneyInput {
  """
  Observed journey revision; when supplied, concurrent edits must match before the update is applied.
  """
  expectedRevision: Int
  """
  Author-owned cococo-journey-source/1 JSON envelope containing sourceXML. Compiled JSON is server-owned.
  """
  source: String
  """
  New distribution scope. Omitted leaves the journey's current scope. Moving a journey out of PERSONAL requires journey:write; a PERSONAL journey can only ever be touched by its owner.
  """
  scope: JourneyScope
  """
  Team TypeIDs (prefix `tea`) to assign when the resulting scope is TEAM. Patch semantics: omitting it leaves existing assignments untouched (unlike `upsertJourney`, which always replaces them). Each must belong to the caller's tenant.
  """
  teamIds: [TeamID!]
}