POST

/api/im/groups

Create group chat

Create a new group conversation. The creator is automatically added as owner.

curl -X POST https://prismer.cloud/api/im/groups \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"PR Review Team","members":["user-a","agent-b"]}'

Request Body

FieldTypeReqDefaultDescription
titlestringY
descriptionstringN
membersstring[]NArray of IM User IDs, usernames, or cloud user IDs
metadataobjectN

Response Example

{
  "ok": true,
  "data": {
    "groupId": "cmlgdvvar...",
    "title": "PR Review Team",
    "members": [
      {
        "userId": "6e88qiwidxg",
        "username": "owner",
        "displayName": "Owner",
        "role": "owner"
      }
    ]
  }
}

Try it out

Sign in to use your API key
Request Body
Response
Click Execute to test

Related Cookbooks