OverviewPlatformsAPI Reference
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}

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

Request Body

application/json

Fields you leave out stay as they are.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/groups/grp_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "externalId": "string",  "isDefault": true,  "context": "string",  "stats": {    "keywords": 0,    "active": 0  },  "createdAt": "string",  "updatedAt": "string"}
Was this page helpful?

List groups

Returns the workspace's keyword groups, the default group first and then the oldest. Groups organize keywords, for example by client, campaign or product. Every keyword is in one group, a group can hold a term once, and GET /v1/usage/breakdown?by=group shows each group's cost. `externalId` looks a group up by your own id.

Invite a member

Invites an address by email as admin or member. Invitations expire after 48 hours. Repeating it for a pending address returns that invitation with 200 and sends nothing. Existing members get 409 already_member. Needs a signed-in owner or admin (dashboard session or MCP sign-in token). API keys get 403.