POST
/
user-groups
Create a user group
curl --request POST \
  --url https://core.ravenna.ai/api/user-groups \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "imageUrl": "<string>",
  "userIds": [
    "<string>"
  ],
  "workspaceIds": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "imageUrl": "<string>",
  "organizationId": "<string>",
  "integrationGroupId": "<string>",
  "_count": {
    "users": 123
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Body

application/json
name
string
required
Minimum length: 1
description
string
emoji
string
icon
string
color
string
imageUrl
string<uri>
userIds
string[]
workspaceIds
string[]

Response

Successful response

id
string
required
name
string
required
description
string | null
required
imageUrl
string | null
required
organizationId
string
required
integrationGroupId
string | null
required
createdAt
string
required
updatedAt
string
required
emoji
string | null
icon
string | null
color
string | null
_count
object