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.
SecurityTdApikeyAuth
Request
path Parameters
journeyBundleId
required
integer <int64>

Journey Bundle ID

Request Body schema: application/json
required

parameters to edit the name and description of the journey bundle

id
string[1-9][0-9]*
type
string
Value: "journeyBundle"
object (partial_journey.yaml-JourneyBundleMetaAttributes)
object
Responses
200

Returns the list of the journeys

patch/entities/journey_bundles/{journeyBundleId}
Request samples
application/json
{
  • "id": "string",
  • "type": "journeyBundle",
  • "attributes": {
    },
  • "relationships": {
    }
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "latestJourneyId": null,
  • "lastVersionNumber": 0,
  • "journeys": [
    ],
  • "latestExecution": {
    },
  • "parentSegmentLatestExecution": {
    },
  • "included": [
    ]
}