Skip to main content
PUT
/
api
/
users
/
profile
Update User Profile
curl --request PUT \
  --url https://api.example.com/api/users/profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>"
}
'
{
  "success": true,
  "message": "<string>"
}

Authentication

This endpoint requires authentication. Include a valid authentication token in your request.

Request Body

All fields are optional. Only include the fields you want to update.
name
string
User’s display name. Must be at least 1 character long.
email
string
User’s email address. Must be a valid email format. Cannot be an email already in use by another user.

Response

success
boolean
required
Indicates if the profile was updated successfully
message
string
required
Success or error message

Error Responses

400 Bad Request - Email In Use
The provided email is already being used by another user
{
  "success": false,
  "message": "Email already in use"
}
400 Bad Request - Validation Error
Request body validation failed
{
  "success": false,
  "message": "Validation error",
  "errors": [
    {
      "path": ["email"],
      "message": "Invalid email"
    }
  ]
}
500 Internal Server Error
Server error while updating profile
{
  "success": false,
  "message": "Failed to update profile"
}

Example Request

cURL
curl -X PUT https://api.inmobiliaria.com/api/users/profile \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "email": "[email protected]"
  }'

Example Response

{
  "success": true,
  "message": "Profile updated successfully"
}

Validation Rules

  • name: Optional string, minimum 1 character when provided
  • email: Optional string, must be valid email format when provided
  • Email uniqueness is checked across all users
  • At least one field should be provided for the update to be meaningful

Build docs developers (and LLMs) love