Skip to main content
POST
/
v1
/
user-comments
Create user comment
curl --request POST \
  --url https://api.light.inc/v1/user-comments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "content": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Body

application/json;charset=UTF-8
​
resourceId
string<uuid>

ID of the resource this comment is attached to (e.g. vendor, customer, etc.).

​
content
string

Comment content.

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>

ID of the comment.

​
companyId
string<uuid>

ID of the company this comment belongs to.

​
resourceId
string<uuid>

ID of the resource this comment is attached to (e.g. vendor, customer, etc.).

​
content
string

Comment content.

​
createdBy
string<uuid>

ID of the user who created the comment.

​
createdAt
string<date-time>

Timestamp when the comment was created.

​
updatedAt
string<date-time>

Timestamp when the comment was last updated.