Delete A Sub-Organization Member

Removes a specific user (admin or member) from a sub-organization by providing the sub-organization ID and the user ID. Removing a user from an Enterprise sub-organization also removes their Enterprise plan subscription. The removed user reverts to their previous plan.

HTTP Method and URL

Authentication Requirements

• Requires a valid user token (typically provided in the user-token header or as a bearer token).

• Only authorized users with sufficient permissions can perform this action.

Path and Query Parameters

Path Parameters:

• subOrganizationUuid (string, required): The unique identifier of the sub-organization.

• subOrgMemberId (string or integer, required): The unique identifier of the user to remove from the sub-organization.

Query Parameters:

• user_type (string, required): Must be set to ENTERPRISE_API.

Request Body

This request does not require a body.

Example Request

DELETE {{host}}/api/v2/sub-organizations/dcd384fd-62e3-481f-8cff-6eda0e90c944/members/17?user_type=ENTERPRISE_API
Headers:
  user-token: <YOUR_TOKEN>

Example Successful Response

{
  "message": "User removed successfully from sub-organization.",
  "removedUserId": 17,
  "subOrganizationUuid": "dcd384fd-62e3-481f-8cff-6eda0e90c944"
}

Error Responses

• 401 Unauthorized: Authentication failed or token missing/invalid.

• 403 Forbidden: Insufficient permissions to remove the user.

• 404 Not Found: Sub-organization or user not found.

• 400 Bad Request: Missing or invalid parameters.

Usage Notes

• Removing a user from a sub-organization is irreversible via this endpoint.

• The user will lose access to all resources associated with the sub-organization.

• Ensure you have the correct IDs before performing this operation.