--- title: "Resume journey and associated activations schedules." method: PATCH path: "/entities/journeys/{journeyId}/resume" tags: ["Journeys"] --- # Resume journey and associated activations schedules. `PATCH /entities/journeys/{journeyId}/resume` Resume journey and associated activations schedules. ## Path parameters - `journeyId` integer, required ## Response `200` Returns a summary of the journey - EntitiesGetJourneyJsonApiResponse - `data` JourneyJsonApiResource, required - `id` string, required - `type` 'journey', required - `attributes` object, required - `audienceId` string, required - `name` string, required - `description` string, nullable, required - `state` 'draft' | 'simulation' | 'launched', required - `goal` JourneyCriteria, nullable, required - `name` string, required - `description` string - `segmentId` string, required - `target` JourneyJumpTarget - `journeyId` string, required — ID of an existing journey to jump to. - `journeyStageId` string, required — ID of an existing stage within the target journey to jump to. - `journeyBundleId` string, nullable - `stageOrderIndex` integer, nullable - `jumpReferenceId` string, nullable — The reference id of the jump target. This is used to identify the jump entity in the included field. - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `launchedAt` string, date-time, nullable, required - `journeyStages` JourneyStageJsonApiResource[], required - `id` string — Server-generated. Omit when creating a stage; supply to target an existing stage when updating. - `name` string, required - `description` string - `steps` JourneyStep, nullable - `uuid` union - union - … - JourneyActivationStep - … - JourneyDecisionPointStep - … - JourneyMergeStep - … - JourneyJumpStep - … - JourneyEndStep, nullable - … - JourneyAbTestStep - … - `rootStep` string - `entryCriteria` JourneyCriteria, nullable - `name` string, required - `description` string - `segmentId` string, required - `target` JourneyJumpTarget - `journeyId` string, required — ID of an existing journey to jump to. - `journeyStageId` string, required — ID of an existing stage within the target journey to jump to. - `journeyBundleId` string, nullable - `stageOrderIndex` integer, nullable - `jumpReferenceId` string, nullable — The reference id of the jump target. This is used to identify the jump entity in the included field. - `milestone` JourneyCriteria, nullable - `name` string, required - `description` string - `segmentId` string, required - `target` JourneyJumpTarget - `journeyId` string, required — ID of an existing journey to jump to. - `journeyStageId` string, required — ID of an existing stage within the target journey to jump to. - `journeyBundleId` string, nullable - `stageOrderIndex` integer, nullable - `jumpReferenceId` string, nullable — The reference id of the jump target. This is used to identify the jump entity in the included field. - `exitCriterias` JourneyCriteria[] - `name` string, required - `description` string - `segmentId` string, required - `target` JourneyJumpTarget - `journeyId` string, required — ID of an existing journey to jump to. - `journeyStageId` string, required — ID of an existing stage within the target journey to jump to. - `journeyBundleId` string, nullable - `stageOrderIndex` integer, nullable - `jumpReferenceId` string, nullable — The reference id of the jump target. This is used to identify the jump entity in the included field. - `paused` boolean, required - `pausedAt` string, date-time, nullable, required - `allowReentry` boolean, required - `reentryMode` 'no_reentry' | 'reentry_unless_goal_achieved' | 'reentry_always' - `journeyBundleId` string, nullable - `journeyBundleName` string, nullable - `versionNumber` integer - `journeyBundleDescription` string, nullable - `latestExecution` Execution - `workflowId` string, required - `workflowSessionId` string, required - `createdAt` string, date-time, required - `finishedAt` string, date-time, nullable, required - `status` 'success' | 'canceled' | 'error' | 'canceling' | 'blocked' | 'queued' | 'running', required - `workflowAttemptId` string, required - `relationships` object, required - `parentFolder` RelationshipsFolderJsonApiResource - `data` object - `id` string, required - `type` 'folder-segment', required - `createdBy` RelationshipsUserJsonApiResource - `data` object, nullable - `id` string, required - `type` 'user', required - `updatedBy` RelationshipsUserJsonApiResource - `data` object, nullable - `id` string, required - `type` 'user', required - `included` union[], required - union - UserJsonApiResource - `id` string, required - `type` 'user', required - `attributes` object, required - `tdUserId` string, required - `name` string, required - JourneyJumpFromJourney - `id` string, required - `type` 'journey' | 'journeyStage', required - `attributes` object - `name` string, required - `jumpType` string - `jumpName` string, nullable - `sourceJourneyId` string - `folderName` string - `targetJourneyId` string - `targetStageId` string - `targetStageName` string - `deletedBy` string, nullable - SyndicationJsonApiResource - `id` string - `type` 'syndication' - `attributes` object - `audienceId` string, required - `name` string, required - `description` string, nullable, required - `allColumns` boolean — syndication all column flag ('true' means that you use all attribute data) - `columns` object[], required — Syndication column detail. Basic syntax is `{"column": "alias_name", "source": {...}}`. `source` accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without `function` property. - `id` string, uuid - `column` string, required - `source` union, required - … - `scheduleType` 'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly' — Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead. - `scheduleOption` string - `timezone` string - `startAt` string, ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$, nullable — cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected. - `endOn` string, date, nullable - `runStatus` 'scheduled' | 'success' | 'error' | 'canceling' | 'canceled' | 'running' | 'waiting', nullable — Tag should be shown in "Run Status". If the workflow never run before and future schedule is set, 'scheduled' will be shown. - `repeatUnit` 'none' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'once' — Setting an activation repetition cycle such as "day" or "week". - `repeatFrequency` integer — Setting an activation repeat frequency. Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minutes. - `repeatSubFrequency` integer[] — Parameter for more detailed frequency settings. Values are array of integers. Currently, this parameter is only valid for repeat unit "week". For multiple days of the week, each value should be 1 to 7. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday - `connectionId` string - `connectorConfig` object, nullable - `valid` boolean - `notifyOn` string[] - `emailRecipients` integer[] - `executions` SyndicationExecution[] - `workflowId` string, required - `workflowSessionId` string, required - `createdAt` string, date-time, required - `finishedAt` string, date-time, nullable, required - `status` 'success' | 'canceled' | 'error' | 'canceling' | 'blocked' | 'queued' | 'running', required - `workflowAttemptId` string, required - `syndicationId` string - `createdAt` string, date-time, required - `updatedAt` string, date-time, required - `nestedWorkflowProjectName` string - `nestedWorkflowName` string - `activationActionsEnabled` boolean - `lockEnabled` boolean - `activationTemplateId` string - `syndicationBehavior` SyndicationBehaviorResponse, nullable - `columns` object[] — Syndication column detail. Basic syntax is `{"column": "alias_name", "source": {...}}`. `source` accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without `function` property. - … - `behaviorTableName` string — Behavior table name which contains behavior records - `joinRow` integer, nullable — How much rows would be joined (value is N for Top-N join) - `joinStrategy` 'All' | 'First' | 'Last' | 'Top-N' — Label of what is the wanted record(s). - `formatting` 'rows' | 'cols' - `orderBy` object[] - … - `syndicationBehaviors` SyndicationBehaviorResponse[], nullable — Behavior activation configurations - `columns` object[] — Syndication column detail. Basic syntax is `{"column": "alias_name", "source": {...}}`. `source` accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without `function` property. - … - `behaviorTableName` string — Behavior table name which contains behavior records - `joinRow` integer, nullable — How much rows would be joined (value is N for Top-N join) - `joinStrategy` 'All' | 'First' | 'Last' | 'Top-N' — Label of what is the wanted record(s). - `formatting` 'rows' | 'cols' - `orderBy` object[] - … - `relationships` object - `segment` RelationshipsBatchSegmentJsonApiResource - `data` object - … - `createdBy` RelationshipsUserJsonApiResource - `data` object, nullable - … - `updatedBy` RelationshipsUserJsonApiResource - `data` object, nullable - … - JourneyActivationStepJsonApiResource — unresolved $ref --- [API](https://skmtc.net/treasure/apis/cdp-api.md) · [All operations](https://skmtc.net/treasure/apis/cdp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/treasure/cdp-api/revisions/24caa8eb809b/schema)