Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
workspace

Delete Member From User Group

Removes a member from the specified group. Requires group_members_manage permission.

post/v1/workspace/groups/{group_id}/members/remove

Path parameters

group_idstring required

The ID of the target group.

The ID of the target group.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

emailstring required

The email of the target workspace member.

Response

Successful Response

statusstring required

The status of the workspace group member deletion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}