Skip to content
API Documents/
/
/
Update journey entity

Update journey entity

Request

Update a journey entity.

Security
TdApikeyAuth
Path
journeyIdinteger, (int64)required

Journey ID

Bodyapplication/vnd.treasuredata.v1+jsonrequired

parameters to update a journey

typestring
Value:"journey"
attributesobject
curl -i -X PATCH \
  'https://api-cdp.treasuredata.com/entities/journeys/{journeyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "type": "journey",
    "attributes": {
      "name": "string",
      "description": "string",
      "state": "draft",
      "goal": {
        "name": "string",
        "description": "string",
        "segmentId": "string",
        "target": {
          "journeyId": "string",
          "journeyStageId": "string"
        }
      },
      "journeyStages": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "steps": {
            "uuid": {
              "type": "WaitStep",
              "name": "string",
              "waitStepType": "Duration",
              "waitStep": 0,
              "waitStepUnit": "day",
              "next": "string"
            }
          },
          "rootStep": "string",
          "entryCriteria": {
            "name": "string",
            "description": "string",
            "segmentId": "string",
            "target": {
              "journeyId": "string",
              "journeyStageId": "string"
            }
          },
          "milestone": {
            "name": "string",
            "description": "string",
            "segmentId": "string",
            "target": {
              "journeyId": "string",
              "journeyStageId": "string"
            }
          },
          "exitCriterias": [
            {
              "name": "string",
              "description": "string",
              "segmentId": "string",
              "target": {
                "journeyId": "string",
                "journeyStageId": "string"
              }
            }
          ]
        }
      ],
      "allowReentry": true,
      "reentryMode": "no_reentry",
      "journeyBundleId": "string",
      "journeyBundleName": "string",
      "journeyBundleDescription": "string"
    }
  }'

Responses

Returns a summary of the updated journey

Bodyapplication/vnd.treasuredata.v1+json
dataobject(JourneyJsonApiResource)required
includedArray of anyrequired
Response
{
  "data": {
    "id": "string",
    "type": "journey",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ]
}