Skip to main content
POST
Create a group

Authorizations

Authorization
string
header
required

Authorization: Bearer YOUR_API_KEY. /v2 accepts no other method.

Body

application/json
id
string
required

Your own identifier for this group, unique per workspace. data_id is accepted as an alias.

Maximum string length: 255
name
string

Display name in the dashboard. Falls back to id.

Maximum string length: 255
type
string
default:company

Free-form label, lowercased and hyphenated, e.g. company, team, key-account. Capped at 10 distinct types per workspace; beyond the cap a new type falls back to company rather than erroring.

Maximum string length: 64
weight
integer
default:1

How important this group is to you. Clamped to the range.

Required range: 0 <= x <= 10
mrr
integer
default:0

Monthly recurring revenue in whole units of your currency. No minor units, no conversion.

meta
object

Flat key/value custom data, string values only. Up to 20 keys, each key and value up to 255 characters.

Response

Created

status
string
data
object

The published shape of a group. Fields are added over time and never removed — ignore any you do not recognise.