← All types
Apps & SurfacesIn Input object

CreateJourneyInput

Input for createJourney: always creates a fresh journey (there is no id to look up), leaving it with a single unpublished draft version.

Fields

source

String!Required

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

Distribution scope of the new journey. Defaults to INSTANCE when omitted. PERSONAL (owned by the caller) is self-service; TEAM/INSTANCE requires journey:write.

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 scope is TEAM; at least one is required then, and each must belong to the caller's tenant. Ignored otherwise.

Referenced by (1)
Exact type SDL
"""
Input for `createJourney`: always creates a fresh journey (there is no id to look up), leaving it with a single unpublished draft version.
"""
input CreateJourneyInput {
  """
  Author-owned cococo-journey-source/1 JSON envelope containing sourceXML. Compiled JSON is server-owned.
  """
  source: String!
  """
  Distribution scope of the new journey. Defaults to INSTANCE when omitted. PERSONAL (owned by the caller) is self-service; TEAM/INSTANCE requires journey:write.
  """
  scope: JourneyScope
  """
  Team TypeIDs (prefix `tea`) to assign when `scope` is TEAM; at least one is required then, and each must belong to the caller's tenant. Ignored otherwise.
  """
  teamIds: [TeamID!]
}