L lumi developers

Ideas / REFERENCE

Update an idea

Creates or updates the editable idea fields. New ideas are private and pending moderation. Creation and status changes queue identifier-only webhooks after commit.

PATCH/api/v1/ideas/{id}

Permissions ideas:write

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.
idpath · requiredRecord identifier in this workspace.

Request body

FieldType & description
titlestring

titleArstring

descriptionstring

statusstring

Configured status value from /ideas/labels.

modulestring

Configured module value from /ideas/labels.

Responses

200 Successful operation
{
  "ok": true,
  "data": {
    "id": "example",
    "title": "example",
    "titleAr": "example",
    "description": "example",
    "category": "example",
    "source": "example",
    "status": "example",
    "module": "example",
    "moderationStatus": "pending",
    "visibility": "private",
    "votes": 1,
    "officialUpdate": "example",
    "effortScore": 1,
    "benefitScore": 1,
    "priorityScore": 1,
    "priorityBand": "example",
    "internalTags": [
      "example"
    ],
    "rejectionReason": "example",
    "publishedAt": "2026-09-26T09:00:00Z",
    "updatedAt": "2026-09-26T09:00:00Z"
  }
}
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.