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.

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

name*string

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

Length1 <= length <= 80

externalId?|

An id from your own system, such as a client id. Must be unique in the workspace. Find the group with GET /v1/groups?externalId=.

Length1 <= length <= 128

context?|

Up to 4000 characters the classifier treats as "the company" for this group's keywords. It fully replaces the workspace profile, including its relevance guidelines and competitors. Describe the business, what it sells and to whom, what it is not, and any rule for this group, such as "ignore job posts". With one group per client, use the client's description. Null means the workspace profile is used.

Lengthlength <= 4000

Response Body

`application/json`

curl -X POST "https://example.com/v1/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "string",  "name": "string",  "externalId": "string",  "isDefault": true,  "context": "string",  "stats": {    "keywords": 0,    "active": 0  },  "createdAt": "string",  "updatedAt": "string"}

Create a group

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

401application/json

409application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`