Create Group API

This API lets you create a group which will return group_id

Create Group API

POST https://api.roam.ai/v1/api/group/

Headers

Name	Type	Description
Api-key	string	Auth-key E.g.- a88d1dddd5ec4be18d7009e0ed4ad59f

Request Body

Name	Type	Description
description	string	Naming group_id E.g.- test user

200

{
    "status": true,
    "msg": "Success.",
    "code": 201,
    "data": {
        "group_id": "63219da797f30b287431c4c5",
        "project_id": "620e3ab8dea1d50efec54581",
        "description": "user-group-11",
        "users": ["62eb672606f8a0093ab8e3ab", "621e0782aa28db38198093e6"],
        "updated_at": "2022-09-14T09:23:51.456",
        "created_at": "2022-09-14T09:23:51.456"
    }
}

Sample Request

curl --location --request POST 'https://api.roam.ai/v1/api/group/' \
--header 'Api-Key: 289eb8eb262140629664078bec76d60c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "users": [
        "62eb672606f8a0093ab8e3ab",
        "621e0782aa28db38198093e6"
    ],
    "description": "user-group-11"
}'