Mentions

Update a mention

The only way to change a mention. Set status to ignored or done when it is handled, or back to open. You can also assign it to a member, snooze it out of the feed, add a note for your team, or correct the classifier. relevant true or false is your judgment, which sets relevance to 100 or 0 for every list, filter, digest and report. sentiment replaces the label. Null removes your correction and brings back the classifier's value. Fields you leave out stay as they are. Delivery and billing are never affected.

patch/v1/mentions/{id}

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/mentions/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Mention id (mm_...).

Example:mm_abc123

Request body

status'open' | 'ignored' | 'done'

ignored or done marks it handled, and open reopens it.

assigneeIdstring nullable

The user id of a workspace member, or null to remove the assignment.

snoozedUntilstring date-time

Hides the mention from the feed until this time, given as ISO 8601 or epoch ms. Send null to bring it back now.

notestring nullable

A note for your team. Null or an empty string removes it.

relevantboolean nullable

Set it to override the classifier, or null to restore the classifier's score. true means relevance 100, and a filtered mention joins the relevant feed. false means 0, and it leaves. Billing is unaffected. While the mention is still being classified this returns 409 classification_pending.

sentiment'positive' | 'neutral' | 'negative' nullable

The sentiment you choose. Null removes it and brings back the classifier's.

Response

The updated mention

idstring required

The mention's id (mm_...). A mention is one post matched to one keyword, so a post that matches two keywords has two ids.

status'open' | 'ignored' | 'done' required

open means no one has handled it. ignored means you hid it from the feed and channels. done means it was handled.

relevantboolean required

True when the classifier's relevance score is 40 or more, the delivery threshold.

deliveredboolean required

true once any channel of yours received it.

prioritynumber required

How much the mention deserves attention, with one decimal, worked out when you read it. It adds half the relevance, points for the author's followers (8 when unknown) and points for the strongest intent (from 20 for buy intent down to 5 for praise). It then takes off 2 points per day of age, at most 20.

parentMentionIdstring nullable required

For a comment whose parent post or comment is itself one of your mentions: that mention's id (mm_...). Null otherwise.

createdAtstring required

When the match was stored. The feed is sorted by this by default.

Changes

No recorded changes to this operation across all 1 revision of this API.