Groups

Create a group

Create a keyword group. name is unique per workspace; externalId (optional, unique too) is your own id for it, a customer id say, so you can find it again without storing ours; context (optional) is the group's own company description, which the classifier reads in place of the whole workspace profile for the group's keywords. Then pass the group id as groupId when creating a keyword.

post/v1/groups

Request

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

Request body

namestring required

The group's name: a customer, a campaign, a product. Unique per workspace.

externalIdstring nullable

Your own id for the group (a customer id, say). Unique per workspace; find the group by it with GET /v1/groups?externalId=.

contextstring nullable

What the classifier reads as "the company" for this group's keywords, in place of the WHOLE workspace profile, its relevance guidelines and competitor list included (at most 4000 characters): who the business is, what it sells, for whom, what is not it, and any rule that should apply to this group ("ignore job posts"). For a group per customer, the customer's description. Null: the workspace profile, as for every keyword before groups.

Response

The new group

idstring required

Group id (grp_...).

namestring required

The group's name.

externalIdstring nullable required

Your own id for the group, or null.

isDefaultboolean required

The workspace's default group, where a keyword lands when no group is named.

contextstring nullable required

The group's own company description for the classifier, or null for the workspace profile.

createdAtstring required

ISO 8601 timestamp, UTC.

updatedAtstring required

ISO 8601 timestamp, UTC.

Changes

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