Remove members

Remove users from an organization user group. This endpoint allows you to remove one or more users from an existing user group.

DELETE https://api.tedee.com/api/v37/organization/{organizationId}/user-groups/{groupId}/members

URI Parameters

Name	Type	Description
groupId	UUID	id of user group
organizationId	number	id of organization

Body Parameters

Name	Type	Description
organizationUserIds	number []	List of organization user IDs to remove

Responses

Name	Type	Description
207 Multi-Status	Organization member operation result []	successful operation

Scopes

Name	Description
Organization.ReadWrite	Grants user possibility to read and write organization data

Examples

Remove single member

Sample request

curl -X DELETE "https://api.tedee.com/api/v37/organization/1/user-groups/a4d5e6f7-8b9c-4d2e-9f1a-3b4c5d6e7f8a/members" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "organizationUserIds": [12]
}

Sample response

HTTP status code: 207

{
    "organizationUsers": [
        {
            "organizationUserId": 12,
            "success": true,
            "error": null
        }
    ]
}

Remove multiple members

Sample request

curl -X DELETE "https://api.tedee.com/api/v37/organization/1/user-groups/a4d5e6f7-8b9c-4d2e-9f1a-3b4c5d6e7f8a/members" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer <<access token>>" -d "<<body>>"

Body:

{
    "organizationUserIds": [11, 12, 13]
}

Sample response

HTTP status code: 207

{
    "organizationUsers": [
        {
            "organizationUserId": 11,
            "success": true,
            "error": null
        },
        {
            "organizationUserId": 12,
            "success": true,
            "error": null
        }
    ]
}

Note

Removing users from a group does not remove their individual device accesses. Only accesses granted through the group membership are affected.