workspace

Delete Member From User Group

Changed on

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

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/workspace/groups/{group_id}/members/remove
  • Auth
    none declared

Path parameters

group_idstring required

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.

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"
}

Changes

  • 5b595807512cRevision changes
    • info

      api operation id Delete_member_from_user_group_v1_workspace_groups__group_id__members_remove_post removed and replaced with remove_member

    • info

      the header request parameter xi-api-key became optional

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type

  • 503db4198a44Revision changes
    • info

      endpoint added