Groups

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.

post/v1/groups

Request

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

Request body

namestring required

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

externalIdstring nullable

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=.

contextstring nullable

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.

Response

The group that was created

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.