Create Comment

Create a team comment on a booking, customer, or stock item. Parses @mentions from the body and notifies mentioned users and previous thread participants. App connections need the booking:write or inventory:write scope.

POST

/api/v1/comment

POST

/comment

curl -X POST "https://dash.lockii.app/api/v1/comment" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "body": "string"
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

id
string
required
Comment ID, usually comment_<uuid>
body
string
required
Comment text. Use @Name syntax for @mentions.
orderID
string
Booking/order ID. Provide orderID, customerID, or stockID.
customerID
string
Customer ID. Provide orderID, customerID, or stockID.
stockID
string
Stock item ID. Provide orderID, customerID, or stockID.
companyID
string
Company ID. Defaults to the authenticated user's company.
createdAt
number
Unix ms. Defaults to now.
updatedAt
number
Unix ms. Defaults to now.

Response

application/json

JSON result for this operation.

object

{}