Skip to main content
POST
Send mention notifications to mentioned users

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