DEdemodesk
Groups

Remove group member

Changed on

Removes a user from a restricted group of the company.

The operation is idempotent. It returns 204 whether or not the user was a member.

Shared groups contain every user of the company, so their membership cannot be changed and the request returns 400 with the code group_not_restricted.

Changing the membership has the same effects as in Settings > Groups, including updating the group visibility of the user's scheduled meetings and removing the user from the group's meeting types.

Changing a group requires the permission to edit it in the web app: a company admin, or a manager who is a member of the group. A group that is readable but not editable returns 403. A group that is unknown, personal, or not readable returns 404 with the code group_not_found. A user that is unknown or in another company returns 404 with the code user_not_found. Blocked users can still be removed, so offboarding scripts can clean up their memberships.

Rate limits:

  • Global: 120 requests per minute per API key.
delete/groups/{groupId}/members/{userId}

Request

  • Base URL
    https://demodesk.com/api/v2
  • Auth
    HTTP bearer

Path parameters

groupIdstring required

Id of the group, as returned by the group list.

userIdstring required

Id of the user. Use the id returned when the user was created (POST /api/v1/users). The user list (GET /users) only contains users who have finished onboarding, so a just-invited user is not in it yet, but can already be added to groups.

Response

The user is not a member of the group, whether they were removed now or never were one.

Changes