Surveys / REFERENCE

Create a live survey link

Returns a respondent token once. Replaces the previous active link of this kind. Test links support drafts and published versions; live links require publication. Treat the token as a secret.

POST/api/v1/surveys/{id}/versions/{versionId}/live-link

Permissions surveys:links: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.
`id`path · required	Record identifier in this workspace.
`versionId`path · required	Record identifier in this workspace.

Responses

200 Successful operation

{
  "ok": true,
  "token": "example",
  "kind": "live",
  "versionId": "00000000-0000-4000-8000-000000000001",
  "scope": {
    "space": "example",
    "generation": 1
  }
}

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"
}