Update journey entity

Update a journey entity.

SecurityTdApikeyAuth

Request

path Parameters

journeyId

required

integer <int64>

Journey ID

Responses

200

Returns a summary of the updated journey

patch/entities/journeys/{journeyId}

Request samples

curl
JS

Response samples

application/vnd.treasuredata.v1+json

{"data": {"id": "string",
"type": "journey",
"attributes": {"audienceId": "string",
"name": "string",
"description": "string",
"state": "string",
"goal": {"name": "string",
"description": "string",
"segmentId": "string",
"target": {"journeyId": "string",
"journeyStageId": "string",
"journeyBundleId": "string",
"stageOrderIndex": 0,
"jumpReferenceId": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"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",
"journeyBundleId": "string",
"stageOrderIndex": 0,
"jumpReferenceId": "string"
}
},
"milestone": {"name": "string",
"description": "string",
"segmentId": "string",
"target": {"journeyId": "string",
"journeyStageId": "string",
"journeyBundleId": "string",
"stageOrderIndex": 0,
"jumpReferenceId": "string"
}
},
"exitCriterias": [{"name": "string",
"description": "string",
"segmentId": "string",
"target": {"journeyId": null,
"journeyStageId": null,
"journeyBundleId": null,
"stageOrderIndex": null,
"jumpReferenceId": null
}
}
]
}
],
"paused": true,
"pausedAt": "2019-08-24T14:15:22Z",
"allowReentry": true,
"reentryMode": "no_reentry",
"journeyBundleId": "string",
"journeyBundleName": "string",
"versionNumber": 0,
"journeyBundleDescription": "string",
"latestExecution": {"workflowId": "string",
"workflowSessionId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"status": "success",
"workflowAttemptId": "string",
"audienceId": "string"
}
},
"relationships": {"parentFolder": {"data": {"id": "string",
"type": "folder-segment"
}
},
"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
},
"included": [{"id": "string",
"type": "user",
"attributes": {"tdUserId": "string",
"name": "string"
}
}
]
}