People

Update your annotations on a person

Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With groupId the annotations are that keyword group's own: muted hides the person, and the accounts that group merged into them, from the mentions of that group's keywords only (feed, alerts and digests), and the group's tags show on those mentions next to the workspace's. A mute set without groupId hides them everywhere.

patch/v1/people/{id}

Request

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

Path parameters

idstring required

Person id (aut_...).

Example:aut_abc123

Query parameters

groupIdstring

Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.

Request body

tagsstring[]

Replaces the whole list.

notesstring
mutedboolean

true hides their posts from the feed, the alerts and the digests; false shows them again. Without groupId, for every keyword of the workspace; with groupId, for the mentions of that group's keywords only, leaving the workspace's mute as it is.

ownerIdstring nullable

The member who owns the contact (user id); null clears.

stage'not_contacted' | 'contacted' | 'replied' | 'in_talks' | 'customer' | 'not_a_fit'

Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.

Response

The updated person

idstring required

Person id (aut_...): the canonical account. An account merged into someone resolves to that person.

platform'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss' required

Platform of the canonical account; accounts lists every account.

namestring nullable required

Display name as of their newest post; null when the platform has none.

handlestring nullable required

Platform handle of the canonical account, formatted as the platform shows it.

urlstring nullable required

Profile URL of the canonical account.

avatarUrlstring nullable required

Changes

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