Updates the details of the user groups like name, active status, and permissions.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| group-id | string | required | Pass the ID of the user group to update its details. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| permissions | array | optional | Pass a list of permission objects to assign to the user group. |
| is_active | boolean | optional | Pass True if the user group is active. Else pass False. |
| name | string | optional | Pass the name of the user group. |
| description | string | optional | Pass any additional information stating the use of the permission group. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request PUT \
--url "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/218c7313-90f9-494b-86cb-f8b09aa37d67/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"permissions": [
{}
],
"is_active": false,
"name": "Test Updated Group",
"description": "Test User Group"
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/218c7313-90f9-494b-86cb-f8b09aa37d67/?AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "PUT",
headers: {},
body: JSON.stringify({
"permissions": [
{}
],
"is_active": false,
"name": "Test Updated Group",
"description": "Test User Group"
}),
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/groups/218c7313-90f9-494b-86cb-f8b09aa37d67/"
params = {
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"permissions": [
{}
],
"is_active": false,
"name": "Test Updated Group",
"description": "Test User Group"
}
response = requests.request("PUT", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"permissions": [
{}
],
"is_active": false,
"name": "Test Updated Group",
"description": "Test User Group"
}View-only example — running live API calls requires a role with snippet testing access.
{
"details": "Successfully updated"
}View-only example — running live API calls requires a role with snippet testing access.