---
title: "Email teammates who were @mentioned in a comment"
description: "Requires a signed-in session (Authorization Bearer) and current membership of the workspace in X-Workspace-Id. Takes only the id of a comment the caller saved in this workspace in the last 24 hours. The email uses that comment's stored text and author name, the contact's real name, and the mentions recorded when it was saved; only current members are emailed, and all text is HTML-escaped. The first call claims the send on the comment's mention record (livechat_internal_notes.notified_at, one per message id) and records the outcome (notify_outcome), so a repeated or overlapping call emails no one again and reports the recorded outcome.\n"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › LiveChat

`POST /api/livechat2/notify-mentions`

Requires a signed-in session (Authorization Bearer) and current membership of the workspace in X-Workspace-Id. Takes only the id of a comment the caller saved in this workspace in the last 24 hours. The email uses that comment's stored text and author name, the contact's real name, and the mentions recorded when it was saved; only current members are emailed, and all text is HTML-escaped. The first call claims the send on the comment's mention record (livechat_internal_notes.notified_at, one per message id) and records the outcome (notify_outcome), so a repeated or overlapping call emails no one again and reports the recorded outcome.

## Authentication

- `bearerAuth`

## Header parameters

- `X-Workspace-Id` (`post/api/livechat2/notify-mentions.header.X-Workspace-Id`; string, required)

## Request body

_Required._

- `messageId` (`post/api/livechat2/notify-mentions.messageId`; string, required) — Id returned by save-comment
  - format `uuid`
- `workspaceId` (`post/api/livechat2/notify-mentions.workspaceId`; string, optional)

## Example request

```json
{
  "workspaceId": "string",
  "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.channelautomation.com/api/livechat2/notify-mentions \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: string' \
  --data '
{
  "workspaceId": "string",
  "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85"
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/livechat2/notify-mentions';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'X-Workspace-Id': 'string'},
  body: JSON.stringify({workspaceId: 'string', messageId: '8540d774-4863-4d2b-b788-4ecb19412e85'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/livechat2/notify-mentions"

payload = {
    "workspaceId": "string",
    "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85"
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "string"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

{ success } — false when any mention email could not be sent (no per-recipient detail). A repeat call sends nothing and returns the first call's outcome; false while it is unfinished or unknown.

### 400

messageId missing or not a UUID

### 401

No valid signed-in session

### 403

Not a member of the workspace

### 404

No comment by this caller with that id in the last 24 hours

### 503

Identity


Source: https://developer.channelautomations.com/api/post-api-livechat2-notify-mentions/index.md