Complete a Journey

Records completion and answers after current authorization. Pass the original clientSessionId and revisionId when replaying a delayed completion.

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.

answers?

answerSnapshot?

clientSessionId?string

Length1 <= length <= 200

completedAt?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

computedVariables?

contact?

properties?

respondentSnapshot?

revisionId?string

Length1 <= length <= 200

visitorId?string

Length1 <= length <= 200

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/journeys/string/complete" \  -H "Content-Type: application/json" \  -d '{}'

{  "ok": true,  "recorded": true,  "sessionId": "string"}

AI agent or LLM? Read this page as markdown

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`