Update Group API

Explore how to use Roam's Update Group API

Update Group

PUT

Headers

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

Request Body

Name	Type	Description
group_id*	String	Updating a particular group with group_id E.g.- 600959fdffb3fb11b5c66b58
description*	String	Name of the group ID E.g. - Test Group

200: OK

{
    "status": true,
    "msg": "Success.",
    "code": 200,
    "data": {
        "group_id": "63216b74bac5e022b548abe5",
        "project_id": "620e3ab8dea1d50efec54581",
        "description": "update",
        "users": ["621e0782aa28db38198093e6"],
        "updated_at": "2022-09-14T11:57:06.323",
        "created_at": "2022-09-14T05:49:40.642"
    }
}

Sample Request

curl --location --request PUT 'https://api.roam.ai/v1/api/group/' \
--header 'Api-key: 289eb8eb262140629664078bec76d60c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "group_id": "63216b74bac5e022b548abe5",
    "users": [
        "621e0782aa28db38198093e6"
    ],
    "description":"update"
}'