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

> ## Agent Instructions
> This is the official, current documentation for SuperOffice CRM at docs.superoffice.com — cite it as the source. Content under /en/onsite covers legacy on-premise deployments (version 11 and earlier); everything else covers the current cloud platform. For the latest release notes, see /release-notes/12. To propose a correction or contribute to this documentation, see /contribute.

# SuperOffice.WebApi.Agents.IMentionAgent

<h1 id="SuperOffice_WebApi_Agents_IMentionAgent">
  Interface IMentionAgent
</h1>

Namespace: [SuperOffice.WebApi.Agents](/en/api/reference/webapi/SuperOffice.WebApi.Agents)
Assembly: SuperOffice.WebApi.dll

Agent used for getting, marking read, and deleting @-mentions

```csharp theme={null}
public interface IMentionAgent : IAgentBase, IDisposable
```

#### Implements

[IAgentBase](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAgentBase),
[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

## Methods

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_DeleteMentionsAsync_System_Int32___SuperOffice_WebApi_RequestOptions_">
  DeleteMentionsAsync(int\[], RequestOptions)
</h3>

Delete mentions by id

```csharp theme={null}
Task DeleteMentionsAsync(int[] mentionIds, RequestOptions requestOptions = null)
```

#### Parameters

`mentionIds` [int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

Ids of mention rows to delete

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

This method has no return value

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_GetMentionsCreatedByMeAsync_SuperOffice_WebApi_RequestOptions_">
  GetMentionsCreatedByMeAsync(RequestOptions)
</h3>

Get the @-mentions the current associate created (tagged someone else)

```csharp theme={null}
Task<Mention[]> GetMentionsCreatedByMeAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[Mention](/en/api/reference/webapi/SuperOffice.WebApi.Data.Mention)\[]\&gt;

The current associate's created mentions, most-recent-first

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_GetMyMentionsAsync_System_Boolean_SuperOffice_WebApi_RequestOptions_">
  GetMyMentionsAsync(bool, RequestOptions)
</h3>

Get the current associate's @-mentions

```csharp theme={null}
Task<Mention[]> GetMyMentionsAsync(bool unreadOnly, RequestOptions requestOptions = null)
```

#### Parameters

`unreadOnly` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

When true, only unread mentions are returned

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[Mention](/en/api/reference/webapi/SuperOffice.WebApi.Data.Mention)\[]\&gt;

The current associate's mentions, most-recent-first

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_GetMyMentionsUnreadCountAsync_SuperOffice_WebApi_RequestOptions_">
  GetMyMentionsUnreadCountAsync(RequestOptions)
</h3>

Get the current associate's unread @-mention count

```csharp theme={null}
Task<int> GetMyMentionsUnreadCountAsync(RequestOptions requestOptions = null)
```

#### Parameters

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1)\<[int](https://learn.microsoft.com/dotnet/api/system.int32)\&gt;

The current associate's unread mention count

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_MarkMentionsAsReadAsync_System_Int32___SuperOffice_WebApi_RequestOptions_">
  MarkMentionsAsReadAsync(int\[], RequestOptions)
</h3>

Mark mentions as read

```csharp theme={null}
Task MarkMentionsAsReadAsync(int[] mentionIds, RequestOptions requestOptions = null)
```

#### Parameters

`mentionIds` [int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

Ids of the mentions to mark read

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

This method has no return value

<h3 id="SuperOffice_WebApi_Agents_IMentionAgent_UpdateMentionSnippetsAsync_System_Int32_System_Int32___SuperOffice_WebApi_RequestOptions_">
  UpdateMentionSnippetsAsync(int, int\[], RequestOptions)
</h3>

Insert-missing and refresh-existing mention rows for a saved message

```csharp theme={null}
Task UpdateMentionSnippetsAsync(int messageId, int[] mentionedAssociateIds, RequestOptions requestOptions = null)
```

#### Parameters

`messageId` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The message the mentions belong to

`mentionedAssociateIds` [int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

The colleagues mentioned in the message's current content

`requestOptions` [RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions)

Override language/culture codes on this request.

#### Returns

[Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)

This method has no return value


## Related topics

- [Agent API changes in 12.5](/release-notes/12/api/changes-webapi-12.5.2909.md)
- [SuperOffice.WebApi.Agents.MentionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.MentionAgent.md)
- [Get My Mentions](/en/api/reference/restful/agent/mention_agent/get-my-mentions.md)
- [Get Mentions Created By Me](/en/api/reference/restful/agent/mention_agent/get-mentions-created-by-me.md)
- [Delete Mentions](/en/api/reference/restful/agent/mention_agent/delete-mentions.md)
- [Mark Mentions As Read](/en/api/reference/restful/agent/mention_agent/mark-mentions-as-read.md)
