Groups

Update a group

Changes a group's name, your externalId for it or its company description in context. Null clears externalId. Null clears context too, so the workspace profile applies again. New mentions use the new context right away, and older ones are not scored again. You can rename the default group, but it takes no description, because it is the workspace itself and uses the company profile.

patch/v1/groups/{id}

Request

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

Path parameters

idstring required

The group's id (grp_...).

Example:grp_abc123

Request body

namestring

The group's name, such as a client, campaign or product. Must be unique in the workspace.

externalIdstring nullable

Sets a new external id. Null removes it.

contextstring nullable

Sets a new company description for the group. Null removes it, and the workspace profile applies again. New mentions use it right away, and older ones are not scored again. The default group cannot have one (400 default_group_context), because it is the workspace itself and uses the profile.

Response

The group after the change

idstring required

The group's id (grp_...).

namestring required

Name of the group.

externalIdstring nullable required

An id from your own system, or null.

isDefaultboolean required

True for the workspace's default group. New keywords go there when you don't name a group.

contextstring nullable required

A company description just for this group, which the classifier reads. Null means the workspace profile is used.

createdAtstring required

UTC time in ISO 8601.

updatedAtstring required

UTC time in ISO 8601.

Changes

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