Skip to main content
POST
/
customChannels
/
{channelId}
/
mentions
Add mentions to a custom channel
curl --request POST \
  --url https://api.peakmetrics.com/customChannels/{channelId}/mentions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mentions": [
    {
      "title": "<string>",
      "text": "<string>",
      "author": "<string>",
      "published": "2024-01-15T14:30:45.123Z",
      "url": "<string>",
      "thumbnailUrl": "<string>"
    }
  ]
}
'
{
  "message": "Mentions are queued up for ingestion",
  "count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
channelId
string<uuid>
required

The unique identifier for the custom channel.

Body

application/json
​
mentions
object[]
required

An array of mentions to be added to the custom channel.

Maximum array length: 100

Response

Mentions have been accepted for ingestion

​
message
string
Example:

"Mentions are queued up for ingestion"

​
count
integer

Number of mentions accepted for ingestion