SHOW MENU

Endpoints » /{account_id}/inbox/mention/{topic_id}/{id}

GET https://api.engagor.com/{account_id}/inbox/mention/{topic_id}/{id}

Description

Returns a single mention object (including cases).

Required Access Token Scope

accounts_read

GET Parameters

Param Description Required Default Value
This API endpoint doesn't need any parameters.

Result

A single mention item.

Examples

Fetch content counters for a mention

POST https://api.engagor.com/{account_id}/inbox/mention/{topic_id}/{id}

Description

Updates a single mention object (including cases). Use version 20160108 to use the sendMail option

Required Access Token Scope

accounts_read, accounts_write

POST Parameters

Param Description Required Default Value
updates A JSON encoded object of changes you want to make. Structured as a mention item, but with only the keys you want to update.
(See examples for supported updates.) 		No
list_filter Check if the updated mention still fits in this optional filter No
options A JSON encoded object of options for the update. Supported keys: "tags_edit_mode", "sendMail", "hide_on_service", "delete_on_service" No

Result

The updated mention item.

Examples

Updating the tags of a mention

Adding tags to a mention

Deleting a single tag from a mention

Updating the status of a mention

Assigning a mention

Assigning a mention, with comment

Adding a note to a mention

Changing sentiment of a mention.

Hiding a mention from a service

DELETE https://api.engagor.com/{account_id}/inbox/mention/{topic_id}/{id}

Description

Deletes a single mention object (including cases).

Required Access Token Scope

accounts_write

DELETE Parameters

Param Description Required Default Value
options A JSON encoded object of options. Supported keys: "delete_on_service", "hide_on_service", "block_author_on_service" actions to perform together with the delete No

Result

bool true if delete succeeded

Examples

Deleting a mention with options