Create a new group within an organization. The authenticated user automatically becomes the owner of the newly created group.
Path Parameters
The unique identifier of the organization where the group will be created.
Body Parameters
Unique URL-friendly identifier for the group within the organization. Must be unique within the organization. If not provided but title is provided, the name will be auto-generated from the title by converting it to a slug format.
Display name of the group. This is the human-readable name shown in the UI.
Arbitrary metadata to associate with the group as key-value pairs. Can be used to store additional information about the group. Example: {"department": "engineering", "cost_center": "1234"}
Response
The created group object. Unique identifier for the newly created group.
The URL-friendly identifier of the group.
Display title of the group.
ID of the organization this group belongs to.
Metadata associated with the group.
Timestamp when the group was created.
Timestamp when the group was last updated.
Number of members in the group. Will be 1 initially (the creator).
cURL
cURL (auto-generate name)
JavaScript
Python
Go
curl -X POST 'https://frontier.example.com/v1beta1/organizations/org_123/groups' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"title": "Engineering Team",
"name": "engineering-team",
"metadata": {
"department": "engineering",
"location": "us-west"
}
}'
Success Response
Error: Group Already Exists
Error: Invalid Request
{
"group" : {
"id" : "grp_123456789" ,
"name" : "engineering-team" ,
"title" : "Engineering Team" ,
"org_id" : "org_123" ,
"metadata" : {
"department" : "engineering" ,
"location" : "us-west"
},
"created_at" : "2023-06-20T15:45:00Z" ,
"updated_at" : "2023-06-20T15:45:00Z" ,
"members_count" : 1
}
}