Skip to content

UpsertJourneyInput ​

Type: Input

Authoring input for upsertJourney: create a journey, or overwrite the open draft of the journey whose handle matches the definition's id.

Fields ​

NameTypeDefaultDescription
definitionString!The whole journey as a verbatim JSON document (spec schema 2). The handle is derived from the document's id — it is never passed separately, and it is what decides whether this upsert creates a journey or edits the existing one. Rejected with field errors if it fails journey.schema.json or live-schema validation.
scopeJourneyScopeDistribution scope of the resulting journey. Omitted keeps the existing journey's scope, or defaults to INSTANCE on create. PERSONAL (owned by the caller) is self-service; TEAM/INSTANCE requires journey:write.
teamIds[TeamID!]Team TypeIDs (prefix tea) to assign when the resulting scope is TEAM; at least one is required then, and each must belong to the caller's tenant. Always fully replaces the journey's assignments — omitting it clears them. Ignored for PERSONAL / INSTANCE.

Connect machines, automate workflows, and build custom apps for print production.