Move To Another Sub Org
Use this endpoint to move an organization member to a different sub-organization (or vice versa) and assign them a new role. This operation updates the member's organization and role in a single request. The memberId in the URL path must refer to an existing user in the current organization. The organization_id in the body must be a valid target organization, and the role must be a valid role for that organization.
Request Body Parameters
-
organization_id(string): The ID of the new organization for the member. -
role(string): The new role for the member within the organization.
Usage Notes
-
The
memberIdpath variable must be a valid member of the current organization. -
The
organization_idmust refer to an existing sub-organization or parent organization where the member will be moved. -
The
rolemust be a valid role within the target organization (e.g., "Member"). -
Both fields are required.
Example Request
PUT {{host}}/api/v2/organization/members/36/move
Content-Type: multipart/form-data
Authorization: Bearer {USER-TOKEN}
organization_id=26
role=Member
Example Response
{
"id": 36,
"organization_id": 26,
"role": "Member",
"email": "[email protected]",
"name": "Jane Doe",
"status": "active"
}
Error Response Example
{
"error": "Invalid organization_id or role",
"message": "The specified organization or role does not exist or is not allowed."
}
Response
The response will include the updated details of the member, reflecting the changes made to the role and organization.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
