L lumi developers

Journeys / REFERENCE

Delete a journey

Delete a macro journey. Micro journeys must use the pair deletion endpoint; linked micro journeys cannot be deleted.

DELETE/api/v1/journeys/{journeyId}

Permissions journeys:delete

Parameters

NameDescription
X-Luma-Workspace-Hostheader · requiredYour 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.
journeyIdpath · requiredRecord identifier in this workspace.

Responses

200 Successful operation
{
  "ok": true
}
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"
}
Need an API key? Open Developer Options in your workspace.