Create a new user group in the workspace.

Request Body

name
string
required

Name of the user group

description
string

Description of the user group

Response

group
object

Group details

Example Request

curl -X POST 'https://api.caret.so/v1/workspace/groups' \
  -H 'Authorization: Bearer {api_key}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Marketing Team",
    "description": "Group for marketing team members"
  }'

Example Response

{
  "group": {
    "id": "01887270-23ab-7da0-c95d-9a9e9ebc9i78",
    "name": "Marketing Team",
    "createdAt": "2023-08-22T15:30:00Z"
  }
}