Skip to main content

Update a Group

This endpoint updates a specific group.

info

This operation requires the group manager role.

HTTP Request

PUT /api/v2/group/{id}/

Parameters

NameInTypeRequiredDescription
idpathstringtrueA unique integer value identifying this group
bodybodyGroupfalseThe request body(group params)

Example Body Parameters

{
"name": "string",
"description": "string",
"color": "string",
"visible": boolean
}

Example Request

const inputBody = '{
"name": "string",
"description": "string",
"color": "string",
"visible": boolean
}';
const headers = {
'Content-Type':'application/x-www-form-urlencoded',
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/group/{id}/',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeGroup

Example responses

{
"id": "integer",
"name": "string",
"description": "string",
"slug": "string",
"color": "string",
"privacy": {},
"visible": "boolean",
"active": "boolean",
"subscription_status": {},
"subscribed": "boolean",
"image_bigger": "string",
"image_big": "string",
"image_medium": "string",
"image_small": "string",
"emotional_image": "string",
"emotional_image_position": "integer",
"subscribers_counter": "integer"
"created_at": "string",
"created_by": {},
"managed_by": {}
}