---
title: "Retrieve a list of journey activation templates of specified step"
method: POST
path: "/entities/journeys/{journeyId}/activation_templates_for_step"
tags: ["Journeys"]
---

# Retrieve a list of journey activation templates of specified step

`POST /entities/journeys/{journeyId}/activation_templates_for_step`

## Request

- Base URL: `https://api-cdp.treasuredata.com`
- URL: `https://api-cdp.treasuredata.com/entities/journeys/{journeyId}/activation_templates_for_step`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/treasure/apis/cdp-api/docs/entities/journeys/:journeyId/activation_templates_for_step/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of journey activation templates of specified step.

## Path parameters

- `journeyId` integer, required

## Query parameters

- `stepId` string, uuid

## Request body

- EntitiesJourneyUpdateRepresentation
  - `type` 'journey'
  - `attributes` object
    - `name` string, required
    - `description` string, nullable
    - `state` 'draft' | 'simulation' | 'launched'
    - `goal` 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.
    - `journeyStages` JourneyStageJsonApiResource[]
      - `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
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - JourneyActivationStep
            - `type` 'Activation', required
            - `name` string, required
            - `journeyActivationStepId` string, required
            - `next` string
          - JourneyDecisionPointStep
            - `type` 'DecisionPoint', required
            - `name` string, required
            - `branches` JourneyDecisionPointBranch[], required
              - …
          - JourneyMergeStep
            - `type` 'Merge', required
            - `name` string
            - `next` string
          - JourneyJumpStep
            - `type` 'Jump', required
            - `name` string, required
            - `target` JourneyJumpTarget, required
              - …
          - JourneyEndStep, nullable
            - `type` 'End'
            - `name` string
          - JourneyAbTestStep
            - `type` 'AbTest', required
            - `name` string, required
            - `customizedSplit` boolean, required
            - `uniqueId` string
            - `randomizationMode` 'sticky' | 'reentry' | 'periodic', nullable: Controls how variant assignments behave on re-entry. "sticky" (default): deterministic assignment, same variant on every entry. "reentry": fresh random assignment on each re-entry. "periodic": assignment stable within cadence window, re-randomized at boundary.
            - `periodicCadence` 'weekly' | 'monthly' | 'yearly': Required when randomizationMode is "periodic". Defines the cadence at which variant assignments reset.
            - `periodicBoundaryMonth` integer: Required when periodicCadence is "yearly". Month of the reset boundary (1-12).
            - `periodicBoundaryDay` integer: Required when periodicCadence is "monthly" or "yearly". Day of the reset boundary (1-31). If the specified day exceeds the number of days in a given month, the last day of that month is used.
            - `periodicBoundaryDayOfWeek` integer: Required when periodicCadence is "weekly". Day of the reset boundary using ISO-8601 numbering (1=Monday, 7=Sunday).
            - `enabledCapping` boolean: Enables profile capping on the step
            - `winnerVariantId` string, nullable: Set when a winner variant is declared via PATCH .../ab_test_winner. Response-only; cannot be set through a journey create/update request.
            - `variants` JourneyAbTestVariant[], required
              - …
      - `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.
    - `allowReentry` boolean
    - `reentryMode` 'no_reentry' | 'reentry_unless_goal_achieved' | 'reentry_always'
    - `journeyBundleId` string, nullable: Attach the journey to an existing journey bundle as its next version.
    - `journeyBundleName` string, nullable
    - `journeyBundleDescription` string, nullable

## Response `200`

Returns a list of available behavior table of specified journey

- EntitiesActivationTemplateIndexJsonApiResponse
  - `data` ActivationTemplateIndexJsonApiResponse[], required
    - `id` string
    - `type` 'activation-template'
    - `attributes` object
      - `audienceId` string, required
      - `name` string, required
      - `description` string, nullable, required
      - `kind` integer: 0: batch, 1: batch_journey
      - `allColumns` boolean: activation all column flag ('true' means that you use all attribute data)
      - `columns` union
        - 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.
          - `id` string, uuid
          - `column` string, required
          - `source` union, required
            - ColumnExpression
              - …
            - StringExpression
              - …
        - NullValue, nullable
          - `thisKeyNeverHit` string
      - `scheduleType` 'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly': Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead.
      - `scheduleOption` string, nullable
      - `timezone` string, nullable
      - `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
      - `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, nullable
      - `connectorConfig` object, nullable
      - `notifyOn` string[]
      - `emailRecipients` integer[]
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `state` 'draft' | 'published'
      - `nestedWorkflowProjectName` string, nullable
      - `nestedWorkflowName` string, nullable
      - `activationActionsEnabled` boolean
      - `lockEnabled` boolean
      - `runAfterJourneyRefresh` boolean, nullable: If true, this activation step will be executed immediately after the journey is refreshed. Only available for kind of journey.
      - `syndicationBehavior` ActivationTemplateSyndicationBehaviorProperties
        - `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.
          - `id` string, uuid
          - `column` string, required
          - `source` union, required
            - ColumnExpression
              - …
            - StringExpression
              - …
        - `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'
        - `formatting` 'rows' | 'cols'
        - `orderBy` object[]
          - `key` string
          - `order` 'ascending' | 'descending'
      - `fieldProperties` ActivationTemplateFieldProperties: activation template field properties
        - `locked` ActivationTemplateFieldPropertiesLocked, required: activation template field properties locked
          - `allColumns` boolean
          - `columns` object
          - `connectionId` boolean
          - `connectorConfig` object, nullable
          - `activationActionsEnabled` boolean
          - `syndicationBehavior` object, nullable
            - `tableName` string: Behavior table name which contains behavior records
            - `columns` object
            - `lockAddColumn` boolean
            - `lockDeleteBehaviorTable` boolean
            - `lockEditBehaviorTable` boolean
            - `lockEditJoinRow` boolean
            - `lockEditJoinStrategy` boolean
            - `lockEditFormatting` boolean
            - `lockEditOrderBy` boolean
          - `lockAddColumn` boolean
          - `lockAddString` boolean
          - `lockAddBehavior` boolean
          - `lockEditSchedule` boolean
          - `lockEditNotification` boolean
          - `lockEditWorkflowExecution` boolean
          - `lockEditSequentialActivation` boolean
      - `activationCount` integer: Number of related activations
      - `available` boolean: This template is available or not (It contains PBP PII BLOCKED columns or not)
      - `availableBySegment` boolean: This template is available by the segment or not (It return only with `availableBySegmentId` parameter)
      - `availableByStep` boolean: This template is available by the step or not (It is returned only when `/entities/journeys/{journeyId}/activation_templates_for_step` is called)
    - `relationships` object
      - `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` UserJsonApiResource[], required
    - `id` string, required
    - `type` 'user', required
    - `attributes` object, required
      - `tdUserId` string, required
      - `name` string, required

## Changes

- **2026-09-09** `c7cbe63450a3`: 5 info
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryDay`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryDayOfWeek`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicBoundaryMonth`
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/periodicCadence`
  - …1 more
- **2026-08-14** `f5ae81d77da9`: 1 info
  - added the new optional request property `attributes/journeyStages/items/steps/uuid/oneOf[#/components/schemas/JourneyAbTestStep]/randomizationMode`

[Operation history](https://skmtc.dev/treasure/apis/cdp-api/changes/entities/journeys/:journeyId/activation_templates_for_step/post.md)

---

[API](https://skmtc.dev/treasure/apis/cdp-api.md) - [All operations](https://skmtc.dev/treasure/apis/cdp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/treasure/apis/cdp-api/revisions/2989992e9ba2?raw)