Skip to main content
Removes a member from the team. Their API keys in this team are disabled (not deleted). The team owner cannot be removed, and the caller cannot remove themselves.
Permission required: member:remove
  • Changes that give someone an admin role, or that reduce what an admin can reach, also require the team owner or an admin.

Path Parameters

string
required
Identifier of the member (principal_id)

Headers

string
Optional. Retrying with the same value replays the first result.

Response

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.