workspace

Update Member

Changed on

Updates attributes of a workspace member. Apart from the email identifier, all parameters will remain unchanged unless specified. This endpoint may only be called by workspace administrators.

post/v1/workspace/members

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/members
  • Auth
    none declared

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

Email of the target user.

is_lockedboolean nullable

Whether to lock or unlock the user account.

workspace_role'workspace_admin' | 'workspace_member' | 'workspace_lite_member'

Seat types for workspace members.

workspace_seat_type'workspace_admin' | 'workspace_member' | 'workspace_lite_member'

Seat types for workspace members.

allow_downgrade_to_basic_seatboolean

When unlocking a user whose original seat type has no seats available but a basic seat is available, downgrade the user to a basic seat instead of failing.

Response

Successful Response

statusstring required

The status of the workspace member update 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

  • 775d1f02f1a7Revision changes
    • info

      added the new optional request property

  • 5b595807512cRevision changes
    • breaking

      removed subschema #1 from the request property anyOf list

    • info

      api operation id Update_member_v1_workspace_members_post removed and replaced with update_workspace_member

    • info

      added the new optional request property

    • info

      added to the request property anyOf list

    • info

      request property deprecated