Journeys / REFERENCE

Create a journey

Create a macro journey and its first draft. At least one title is required.

POST/api/v1/journeys

Permissions journeys:write

Parameters

Name	Description
`X-Luma-Workspace-Host`header · required	Your workspace host, e.g. acme.lumi-cx.com. Required on api.lumi-cx.com. This header never grants access: the Bearer key must belong to the selected workspace.

Request body

Field	Type & description
`titleEn`	string
`titleAr`	string
`title`	string Compatibility alias for titleEn.

Responses

200 Successful operation

{
  "ok": true,
  "journeyId": "00000000-0000-4000-8000-000000000001",
  "version": {
    "id": "00000000-0000-4000-8000-000000000001",
    "journeyId": "00000000-0000-4000-8000-000000000001",
    "label": "example",
    "parentVersionId": "00000000-0000-4000-8000-000000000001",
    "content": {
      "schema": 2,
      "stages": [
        {
          "id": "onboarding",
          "titleEn": "Onboarding",
          "titleAr": "",
          "microJourneyPairs": []
        }
      ],
      "rows": [],
      "cells": {}
    },
    "createdBy": "example",
    "createdAt": "2026-09-26T09:00:00Z",
    "updatedAt": "2026-09-26T09:00:00Z",
    "publishedAt": "2026-09-26T09:00:00Z",
    "revision": 1,
    "sourceRevision": 1,
    "legacyOrigin": "example",
    "diagnostics": [
      {
        "severity": "example",
        "message": "example"
      }
    ]
  }
}

400 Invalid request

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

401 Missing, invalid, expired, revoked or wrong-workspace key

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

403 Required key permission missing, module unavailable, or workspace suspended

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

404 Record, workspace or route not found

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

409 Version changed or the resource is locked

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

429 Rate limit exceeded; respect Retry-After

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

502 Upstream or unexpected server error

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}