Add-Mention

Summary

Creates a new mention record.

Add-Mention
    -Entry

Returns a mention object.

Parameters

Examples

Create a new mention

# Create a new mention

# Create an entry object with the necessary fields to create the mention

#NOTE: For `HistoryTableId`, Use 14 to signal that the parent object is a task comment.
#      `PrimaryKeyId` will then be the task comment id

$entry = @{
    HistoryTableId  = 14 
    PrimaryKeyId    = 22406
    ForUserId       = "44a336ad-8212-497d-8f0a-e895bc933378"
}
# Create the mention. The created entry will be returned back.
$data = Add-Mention -Entry $entry

# Output some information to help indicate that the mention was created
Write-Output "Mention $($data.MentionId) for $($data.ForUserFullName) was created"

# For debug purposes, convert the data to output as JSON so we can see all the fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $data | ConvertTo-Json -Depth 10

# Output the data
Write-Output $jsonOutput

# NOTE: Creating a mention does not automatically send a notification to the user. To
#       send a notification, you must call the `Invoke-Notification` cmdlet, like:

Invoke-Notification `
    -RequestType "Mention" `
    -Id $($data.MentionId)

Mention 15423 for Max Miller was created

JSON Results:
{
  "MentionId": 15423,
  "HistoryTableId": 14,
  "HistoryTableName": "Task Comment",
  "ForUserId": "44a336ad-8212-497d-8f0a-e895bc933378",
  "ForUserFullName": "Max Miller",
  "ForUser": null,
  "PrimaryKeyId": 22406,
  "CreatedByFullName": "Tanya Sampson",
  "CreatedById": "47004c9a-93e3-473c-8f96-a0556bf6735d",
  "CreatedOn": "2026-04-16T16:06:03.4502714+00:00",
  "CreatedBy": null
}