insertNote

WRITE

Insert note.

POST /api/v1/shared/insertNote

curl -X POST '<your-host>/api/v1/shared/insertNote' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "note": "string",
    "documentId": "string"
  }'

Response

{
  "active": true,
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "documentId": "string",
  "id": "string",
  "note": "string",
  "noteRichText": "…",
  "updatedAt": "string",
  "updatedBy": "string"
}

Parameters

ParameterType

Input schema

schema

{
  "type": "object",
  "properties": {
    "note": {
      "type": "string"
    },
    "documentId": {
      "type": "string"
    }
  },
  "required": [
    "note",
    "documentId"
  ]
}