Mentions

WARNING

Mentioning other users requires the ticket.agent permission and at least read access to the group of the ticket, full access also qualifies. Otherwise the request fails with HTTP status 403.

List

Required permission: ticket.agent and at least read access to the group of the ticket, full access also qualifies

GET-Request sent: /api/v1/mentions

Details

// HTTP-Code 200 OK

{
  "mentions": [
    {
      "id": 2,
      "mentionable_type": "Ticket",
      "mentionable_id": 1,
      "user_id": 3,
      "updated_by_id": 3,
      "created_by_id": 3,
      "created_at": "2021-03-16T08:51:08.985Z",
      "updated_at": "2021-03-16T08:51:08.985Z"
    },
    {
      "id": 3,
      "mentionable_type": "Ticket",
      "mentionable_id": 1,
      "user_id": 4,
      "updated_by_id": 4,
      "created_by_id": 4,
      "created_at": "2021-03-16T08:51:08.986Z",
      "updated_at": "2021-03-16T08:51:08.986Z"
    }
  ]
}

Create

Required permission: ticket.agent and at least read access to the group of the ticket, full access also qualifies

POST-Request sent: /api/v1/mentions

Details

{
  "mentionable_type": "Ticket",
  "mentionable_id": 12
}

The mention will be created for the user of the current session.

TIP

If you want to mention/subscribe other users, you can do so by sending an additional From-header in your request. You can either provide the user ID or the user email address as value.

Delete

Required permission: ticket.agent

DELETE-Request sent: /api/v1/mentions/{id}

Details

// HTTP-Code 200 OK

{
  "id": 2,
  "mentionable_type": "Ticket",
  "mentionable_id": 1,
  "user_id": 3,
  "updated_by_id": 3,
  "created_by_id": 3,
  "created_at": "2021-03-16T08:51:08.985Z",
  "updated_at": "2021-03-16T08:51:08.985Z"
}