Update an existing group’s details. You can modify the group’s name, title, and metadata.
Path Parameters The unique identifier of the group to update.
Query Parameters The organization ID that the group belongs to. Required for authorization.
Body Parameters New URL-friendly identifier for the group. Must be unique within the organization. If you change the name, any existing references using the old name will need to be updated.
New display name for the group.
Updated metadata for the group. This completely replaces the existing metadata. To remove metadata, pass an empty object {}.
Response The updated group object. Unique identifier for the group (unchanged).
The updated URL-friendly identifier of the group.
The updated display title of the group.
ID of the organization this group belongs to.
The updated metadata associated with the group.
Timestamp when the group was created (unchanged).
Timestamp when the group was last updated. Will reflect the current update time.
Number of members in the group.
cURL
cURL (update name)
JavaScript
Python
Go
curl -X PUT 'https://frontier.example.com/v1beta1/groups/grp_123456789?org_id=org_123' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "title": "Senior Engineering Team", "metadata": { "department": "engineering", "location": "us-west", "team_lead": "Alice Smith" } }'
Success Response
Error: Group Not Found
Error: Name Already Exists
{ "group" : { "id" : "grp_123456789" , "name" : "engineering-team" , "title" : "Senior Engineering Team" , "org_id" : "org_123" , "metadata" : { "department" : "engineering" , "location" : "us-west" , "team_lead" : "Alice Smith" }, "created_at" : "2023-01-15T10:30:00Z" , "updated_at" : "2023-06-25T14:20:00Z" , "members_count" : 12 } }