API reference
Prepare a Journey
Verifies current key, origin, publication, entitlement and capture permissions. Returns the active revision and a 600-second refresh policy. A matching knownRevisionId omits configuration JSON; authorization still runs.
Authorization
publishableKey AuthorizationBearer <token>
A brand-scoped FounderHQ publishable key.
In: header
Path Parameters
journeyId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/journeys/string/prepare" \ -H "Content-Type: application/json" \ -d '{}'{ "captureIdentityMode": "RESPONSES_ONLY", "config": { "property1": "string", "property2": "string" }, "refreshAfterSeconds": 600, "revisionId": "string", "unchanged": true, "version": -9007199254740991}