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": "65c2d0e0f0a0b0c0d0e0f0a0",
  "mentions": [
    "65b1f0a2c3d4e5f6a7b8c9d0",
    "65b1f0a2c3d4e5f6a7b8c9d1"
  ],
  "noteContent": "@alice @brenda please review this lead",
  "authorName": "Cory Tan"
}
'
{
  "success": true,
  "message": "Mention notifications sent",
  "notifications": 2,
  "recipients": [
    "65b1f0a2c3d4e5f6a7b8c9d0",
    "65b1f0a2c3d4e5f6a7b8c9d1"
  ]
}

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

Contact the note relates to (links the notification back to the timeline).

​
mentions
string[]
required

User _ids @-mentioned in the note; each receives a ping.

​
noteContent
string

Plain-text excerpt rendered inside the notification body.

​
authorName
string

Display name of the user who authored the note.

Response

Mention notifications sent

​
success
enum<boolean>
required
Available options:
true
​
notifications
integer
required

Count of notifications successfully created (excludes the author and any failures).

​
recipients
string[]
required

Mentioned userIds the handler attempted to notify, with the author filtered out.

​
message
string