Skip to main content
POST
/
api
/
notifications
/
mentions
Send mention notifications to mentioned users
curl --request POST \
  --url https://your-instance.example.com/api/notifications/mentions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "<string>",
  "mentions": [
    "<string>"
  ],
  "noteContent": "<string>",
  "authorName": "<string>"
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
contactId
string
required
​
mentions
string[]
required
​
noteContent
string
​
authorName
string

Response

Mention notifications sent

Generic response envelope. Endpoint-specific fields are intentionally open.