Sign in
Journeys

Update the metadata of the journey bundle

Update the editable journey bundle information. The following fields are editable with this API.

  • name
  • description
  • latestJourneyId To update the latest journey, the following validation checks the validity of the operation.
  • The journey must exist and belong to this journey bundle
  • The journey must be launched The case when launching new journey as the latest is treated by the POST journey endpoint with the journeyBundleId.
patch/entities/journey_bundles/{journeyBundleId}

Path parameters

journeyBundleIdinteger required

Journey Bundle ID

Request body

idstring
type'journeyBundle'

Response

Returns the list of the journeys

namestring

Name of the journey bundle

descriptionstring

Description of the journey bundle

{"stackTrail":"components:schemas:partial_journey.yaml-EntitiesJourneyBundleJsonApiResponse:properties:latestJourneyId","oasType":"schema","type":"unknown","description":"Derived from the initial journey version name","nullable":false}
lastVersionNumberinteger

The version number of the most recently created journey. If no journey has been created, this will be 0.

Changes

Changed in 1 of the 3 revisions of this API.2

  • f5ae81d77da92See the full diff
    • ○

      added the optional property included/items/anyOf[JourneyJsonApiResource]/attributes/journeyStages/items/steps/uuid/oneOf[JourneyAbTestStep]/randomizationMode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property journeys/items/attributes/journeyStages/items/steps/uuid/oneOf[JourneyAbTestStep]/randomizationMode to the response with the 200 status

      response-optional-property-added