Remove Member from Organization

Removes a specific user (admin or member) from the main organization by providing the member ID of the user to remove. If the user is part of an Enterprise organization, their Enterprise plan subscription is also removed, and the user reverts to their previous plan.

Request

• Method: DELETE
• URL: {{host}}/api/v2/organization/members/:memberId/remove?user_type=ENTERPRISE_API
• Path Variables:
  • memberId (required): The unique identifier of the member to remove.
• Query Parameters:
  • user_type (required): Must be set to ENTERPRISE_API.

Request Body

This endpoint does not require a request body.

Response

Successful response:

{
  "message": "Member removed successfully."
}

Error Response Example

{
  "error": "Member not found or cannot be removed."
}

Usage Notes

• The memberId path variable must correspond to a valid user in the organization.
• The user_type query parameter is required and must be set to ENTERPRISE_API.
• Removing a user from an Enterprise organization will also remove their Enterprise plan subscription.
• The removed user will revert to their previous plan after removal.