Transfer Organization

Transfer Organization

Transfers the ownership of the main organization to another user (admin or member). The transferring user will become an admin, and the new owner will have the role of owner after the transfer.


HTTP Method and URL

POST {{host}}/api/v2/organizations/transfer


Authentication Requirements

  • Requires a valid authentication token (e.g., user-token variable).
  • The user must have sufficient privileges to transfer organization ownership.

Path and Query Parameters

  • This endpoint does not use path or query parameters.

Request Body

  • Content-Type: application/json
  • Body parameters:
    • member_id (integer, required): The ID of the member who will become the new owner.

Example:

{
  "member_id": 5
}

Example Request

POST {{host}}/api/v2/organizations/transfer
Content-Type: application/json
Authorization: Bearer {USER-TOKEN}

{
  "member_id": 5
}

Example Successful Response

{
  "status": "success",
  "message": "Organization ownership transferred successfully."
}

Error Responses

  • 400 Bad Request: Missing or invalid member_id.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to transfer ownership.
  • 404 Not Found: Member with the specified ID does not exist.
  • 409 Conflict: Transfer cannot be completed due to organization rules.

Usage Notes

  • Only admins or owners can transfer organization ownership.
  • After the transfer, the previous owner becomes an admin.
  • Ensure the member_id provided belongs to a valid member or admin within the organization.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!