Mentions

Update a mention's state

Sets whether a mention is seen and/or engaged. Send seen, engaged, or both; omitted fields are left unchanged.

Requires both the mentions:read and mentions:write scopes. Applies to the whole organization (seen and engaged are shared, like read/unread in an inbox), and the change is attributed to the API key or OAuth app acting for its user. occurredAt is optional, defaults to now, and must not be in the future; the current state is decided by the latest occurredAt, so an event older than the current latest is recorded but does not change the state. Returns the mention with its resulting state. Does not consume credits.


PATCH
/mentions/{id}/state

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key (sf_api_… from Integrations → API keys) or a partner OAuth 2.1 access token issued by SnitchFeed (authorization_code + refresh). OAuth tokens must be audience-bound to this API (resource = {apiOrigin}/v1) and carry the route scopes listed per operation.

In: header

Path Parameters

id*string

Mention id (men_...).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

seen?boolean

Set to true to mark the mention seen (read), false to mark it unseen.

engaged?boolean

Set to true to mark the mention engaged (for example, your team replied), false to clear the engaged state. Engaging also marks the mention seen, at the same time. Clearing it does not change whether the mention is seen.

occurredAt?string

ISO 8601 instant the change actually happened. Defaults to now. Must not be in the future (up to 60 seconds of clock skew is tolerated and treated as now). A mention's current state is decided by the latest occurredAt per dimension (seen, engaged), so an event older than the current latest is recorded but does not change the state.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/mentions/string/state" \  -H "Content-Type: application/json" \  -d '{}'
{  "requestId": "string",  "mention": {    "id": "string",    "listenerId": "string",    "platform": "reddit",    "keywords": [      "string"    ],    "status": "ready",    "datePublished": "string",    "dateFound": "string",    "content": {      "url": "string",      "text": "string",      "author": "string",      "authorUrl": "string",      "title": "string",      "subreddit": "string",      "engagement": {        "score": 0,        "comments": 0,        "shares": 0,        "retweets": 0      }    },    "ai": {      "sentiment": "positive",      "fitScore": 0,      "intentTags": [        "string"      ],      "summary": "string",      "language": "string"    },    "state": {      "seen": true,      "lastSeenAt": "string",      "firstSeenAt": "string",      "engaged": true,      "engagedAt": "string",      "archived": true    },    "snitchfeedUrl": "string"  }}