Update A Sub-Organization Member

This endpoint allows you to update a sub-organization member's details, such as their first name, last name, or organization role (Admin or Member). You must provide the sub-organization ID and the member's ID to identify the user to update.

HTTP Method and URL

• Method: PUT

• URL: {{host}}/api/v2/sub-organizations/:subOrganizationUuid/members/:subOrgMemberId?user_type=ENTERPRISE_API

Headers

Authentication Requirements

• Requires a valid Bearer token in the Authorization header.

• The user must have permission to manage sub-organization members.

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 member to update.

• Query Parameters:

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

Request Body

The request body must be sent as multipart/form-data and can include the following fields:

• first_name (string, optional): The new first name of the member. Example: Four

• last_name (string, optional): The new last name of the member. Example: Test

• role (string, optional): The new role for the member. Allowed values: Admin, Member

Example Request

PUT {{host}}/api/v2/sub-organizations/dcd384fd-62e3-481f-8cff-6eda0e90c944/members/17?user_type=ENTERPRISE_API
Authorization: Bearer <user-token>
Content-Type: multipart/form-data
first_name=Four
last_name=Test
role=Admin

Example Successful Response

{
  "status": "success",
  "message": "Sub-organization member updated successfully.",
  "data": {
    "id": 17,
    "first_name": "Four",
    "last_name": "Test",
    "role": "Admin"
  }
}

Error Responses

• 400 Bad Request: Invalid input or missing required fields.

• 401 Unauthorized: Authentication failed or missing token.

• 403 Forbidden: Insufficient permissions to update the member.

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

• 500 Internal Server Error: Unexpected server error.

Usage Notes

• Only fields provided in the request body will be updated; others remain unchanged.

• Ensure the user_type query parameter is set to ENTERPRISE_API.

• The endpoint requires multipart/form-data encoding for the request body.