Planner Notes Mentions Api Service

Get the users that can be mentioned in the notes of the brand's planner posts.

Calendar and library: whoever can see the brand's posts. On a brand of an agency white-label that also covers the agency team members and the agency end clients. Deleted accounts are excluded. Rejected for sessions that cannot mention (integrator and white-label end clients, Vendasta and the anonymous reviewer). The whole list is returned: filtering by the typed text is done by the frontend over the loaded list.

To write a mention into the note content, interpolate the entry's mentionId and its name as @[<mentionId>|<name>].

Use mentionId verbatim and never build it from userId or agencyId/agencyUserId: an agency end client has no userId, so composing the marker from it produces a marker the server cannot resolve and the mention is silently lost — the note saves, with no error, mentioning nobody.

Use name for the label. What is stored is taken from the mentioned account rather than from the request, because the label lives inside the note content and the content is served verbatim to every reader, including sessions that must not see email addresses. A label written beside an id this API cannot resolve is kept as sent, except for an email address, which is reduced to its local part.

get/v2/scheduler/notes/mentionable-users

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/scheduler/notes/mentionable-users
  • Auth: none declared

Response

OK

metadataobject

Example response

{
  "data": [
    {
      "mentionId": "a:37:156",
      "userId": 12345,
      "agencyId": 37,
      "agencyUserId": 156
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.