Groups

Update a group

Rename a group, change your id for it (externalId, null clears) or its company description (context, null clears: the workspace profile applies again; new mentions are judged with it at once, old ones are not rescored). The default group can be renamed like any other but takes no description: it is the workspace itself and reads the company profile.

patch/v1/groups/{id}

Request

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

Path parameters

idstring required

Group id (grp_...).

Example:grp_abc123

Request body

namestring

The group's name: a customer, a campaign, a product. Unique per workspace.

externalIdstring nullable

Replaces your id for the group; null clears it.

contextstring nullable

Replaces the group's company description; null clears it (the workspace profile applies again). New mentions are judged with it at once; old ones are not rescored. Not on the default group (400 default_group_context): that one is the workspace itself and reads the profile.

Response

The updated group

idstring required

Group id (grp_...).

namestring required

The group's name.

externalIdstring nullable required

Your own id for the group, or null.

isDefaultboolean required

The workspace's default group, where a keyword lands when no group is named.

contextstring nullable required

The group's own company description for the classifier, or null for the workspace profile.

createdAtstring required

ISO 8601 timestamp, UTC.

updatedAtstring required

ISO 8601 timestamp, UTC.

Changes

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