Skip to content
API Documents/
/
/
Create journey

Create journey

Request

Create a journey.

Security
TdApikeyAuth
Bodyapplication/vnd.treasuredata.v1+jsonrequired

parameters to create a journey

typestring
Value:"journey"
attributesobject
relationshipsobject
curl -i -X POST \
  https://api-cdp.treasuredata.com/entities/journeys \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "type": "journey",
    "attributes": {
      "name": "My new journey",
      "description": "",
      "state": "draft",
      "journeyStages": [
        {
          "name": "stage1"
        },
        {
          "name": "stage2"
        }
      ]
    },
    "relationships": {
      "parentFolder": {
        "data": {
          "id": "688641",
          "type": "folder-segment"
        }
      }
    }
  }'

Responses

Returns a summary of the journey

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