This section provides detailed information about the User Management API endpoint /ManageUserProfile
. This API allows developers to manage user profiles on the platform.
Overview
The /ManageUserProfile
endpoint is designed to handle various operations related to user profiles, such as updating profile information, changing profile pictures, and retrieving user details.
Endpoint Details
- URL:
/Documentation/en/Developer/APIs/UserManagement/ManageUserProfile
- Method:
GET
,POST
,PUT
,DELETE
- Authentication: Requires valid API key and authentication token.
Request Parameters
user_id
: Unique identifier of the user whose profile needs to be managed.profile_picture
: URL of the new profile picture (only forPOST
andPUT
requests).first_name
: New first name for the user (only forPOST
andPUT
requests).last_name
: New last name for the user (only forPOST
andPUT
requests).email
: New email address for the user (only forPOST
andPUT
requests).phone_number
: New phone number for the user (only forPOST
andPUT
requests).
Response
The response will be in JSON format and will include the updated user profile information or an error message if the request was unsuccessful.
{
"status": "success",
"data": {
"user_id": "123456",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone_number": "+1234567890",
"profile_picture": "https://example.com/profile_pictures/123456.jpg"
}
}
Usage Example
To update a user's profile, send a PUT
request to /Documentation/en/Developer/APIs/UserManagement/ManageUserProfile
with the necessary parameters.
curl -X PUT https://api.example.com/Documentation/en/Developer/APIs/UserManagement/ManageUserProfile \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-d "user_id=123456&first_name=Jane&last_name=Doe&email=jane.doe@example.com&phone_number=+9876543210"
For more detailed usage examples and best practices, please refer to our API Reference.