> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Send mention notifications to mentioned users

> Fan-out helper called by note/comment surfaces when one or more `@user` mentions are detected. Creates a notification per mentioned user (excluding the author) and returns the recipient list.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/notifications/mentions
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/notifications/mentions:
    post:
      tags:
        - Notification
      summary: Send mention notifications to mentioned users
      description: >-
        Fan-out helper called by note/comment surfaces when one or more `@user`
        mentions are detected. Creates a notification per mentioned user
        (excluding the author) and returns the recipient list.
      operationId: post_notifications_mentions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSendMentionsRequest'
      responses:
        '200':
          description: Mention notifications sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationMentionsSentResponse'
        '400':
          description: contactId and mentions array are required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationErrorResponse'
        '500':
          description: Failed to send mention notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    NotificationSendMentionsRequest:
      type: object
      properties:
        contactId:
          type: string
          description: >-
            Contact the note relates to (links the notification back to the
            timeline).
        mentions:
          type: array
          items:
            type: string
          description: User `_id`s @-mentioned in the note; each receives a ping.
        noteContent:
          type: string
          description: Plain-text excerpt rendered inside the notification body.
        authorName:
          type: string
          description: Display name of the user who authored the note.
      required:
        - contactId
        - mentions
      additionalProperties: true
      example:
        contactId: 65c2d0e0f0a0b0c0d0e0f0a0
        mentions:
          - 65b1f0a2c3d4e5f6a7b8c9d0
          - 65b1f0a2c3d4e5f6a7b8c9d1
        noteContent: '@alice @brenda please review this lead'
        authorName: Cory Tan
    NotificationMentionsSentResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        message:
          type: string
        notifications:
          type: integer
          description: >-
            Count of notifications successfully created (excludes the author and
            any failures).
        recipients:
          type: array
          description: >-
            Mentioned userIds the handler attempted to notify, with the author
            filtered out.
          items:
            type: string
      required:
        - success
        - notifications
        - recipients
      additionalProperties: true
      example:
        success: true
        message: Mention notifications sent
        notifications: 2
        recipients:
          - 65b1f0a2c3d4e5f6a7b8c9d0
          - 65b1f0a2c3d4e5f6a7b8c9d1
    NotificationErrorResponse:
      type: object
      description: >-
        Error envelope returned by notification endpoints. 500 paths return `{
        error }`; mention-send failures may also include `details`.
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
        details:
          type: string
      additionalProperties: true
      example:
        success: false
        error: Notification not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````