Create a suggestion

POST /api/v1/suggestions

Error

A valid request URL is required to generate request examples

201

{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "<string>",
    "dbId": 123,
    "entity": {
      "type": "lead",
      "id": "<string>"
    },
    "createdByUserId": "<string>",
    "status": "pending",
    "fieldPath": "<string>",
    "currentValue": "<unknown>",
    "proposedValue": "<unknown>",
    "rationale": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "reviewedAt": "2023-11-07T05:31:56Z",
    "reviewedByUserId": "<string>",
    "reviewNote": "<string>"
  }
}

Body

application/json

entity · object · required

Show child attributes

fieldPath · string · required

Minimum string length: 1

currentValue · any · required

proposedValue · any · required

rationale · string | null · required

Response

201

application/json

Created

ok · any · required

meta · object · required

Show child attributes

data · object · required

Show child attributes