OverviewPlatformsAPI Reference
Groups

Delete a group

Deletes the group and all of its keywords, each as DELETE /v1/keywords/{id} would. Their mentions are deleted too, alert rules that named them are updated, and past charges stay in the usage record. Read the group first, since stats.keywords tells you how many keywords will be deleted. Only non-default groups can be deleted.

DELETE
/v1/groups/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

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

Length1 <= length

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/groups/grp_abc123"
Empty
Was this page helpful?

Create a group

Creates a keyword group. `name` must be unique in the workspace. `externalId` is optional and also unique. It is your own id, such as a client id, so you can find the group without storing ours. `context` is optional. It is a company description for this group, which the classifier reads instead of the workspace profile for the group's keywords. Then send the group's id as `groupId` when you create a keyword.

Get a group

Returns one keyword group with its external id and keyword counts.