Skip to main content
PUT
/
api
/
profile
/
{id}
/
update
Update User Profile
curl --request PUT \
  --url https://api.example.com/api/profile/{id}/update/

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/edimez14/password_generator/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint allows authenticated users to update their profile information. Users can only update their own profile. Supports partial updates and avatar image uploads.

​
Authentication

This endpoint requires authentication. Include a valid JWT access token in the Authorization header: 
Authorization: Bearer <access_token>

​
Authorization

Users can only update their own profile. The authenticated user must match the user ID in the URL path, otherwise a 403 Forbidden error is returned.

​
Request

​
Endpoint

PUT /api/profile/{id}/update/

​
Path Parameters

ParameterTypeDescriptionRequired
idintegerThe user ID (must match authenticated user)Yes

​
Headers

HeaderValueRequired
AuthorizationBearer Yes
Content-Typeapplication/json or multipart/form-dataYes

​
Request Body

Supports partial updates. All fields are optional: 
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "number_phone": "1234567890",
  "username": "john_doe_updated"
}

​
Avatar Upload

To upload an avatar, use multipart/form-data encoding and include the avatar file field: 
curl -X PUT https://api.example.com/api/profile/1/update/ \
  -H "Authorization: Bearer <token>" \
  -F "avatar=@/path/to/image.jpg" \
  -F "first_name=John" \
  -F "last_name=Doe"

​
Request Fields

FieldTypeDescriptionConstraints
usernamestringUser’s usernameOptional, unique
emailstringUser’s email addressOptional, unique, max 200 chars
first_namestringUser’s first nameOptional, max 200 chars
last_namestringUser’s last nameOptional, max 200 chars
number_phonestringUser’s phone numberOptional, max 10 chars
avatarfileProfile image fileOptional, image file (jpg, png, etc.)

​
Response

​
Success Response (200 OK)

Returns the updated user profile data: 
{
  "id": 1,
  "username": "john_doe_updated",
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe",
  "number_phone": "1234567890",
  "avatar": "/media/avatars/image.jpg",
  "date_joined": "2024-01-15T10:30:00Z",
  "last_login": "2024-03-10T14:20:00Z",
  "is_active": true,
  "is_staff": false,
  "is_superuser": false
}

​
Response Fields

FieldTypeDescription
idintegerUnique user identifier
usernamestringUser’s username
emailstringUser’s email address
first_namestringUser’s first name
last_namestringUser’s last name
number_phonestringUser’s phone number
avatarstringURL path to user’s avatar image
date_joineddatetimeWhen the user account was created
last_logindatetimeLast login timestamp
is_activebooleanWhether the user account is active
is_staffbooleanWhether user has staff privileges
is_superuserbooleanWhether user has superuser privileges

​
Error Responses

​
400 Bad Request

Returned when the request data is invalid: 
{
  "email": [
    "This field must be a valid email address."
  ],
  "username": [
    "A user with that username already exists."
  ]
}

​
401 Unauthorized

Returned when the authentication token is missing or invalid: 
{
  "detail": "Authentication credentials were not provided."
}

​
403 Forbidden

Returned when the authenticated user tries to update another user’s profile: 
{
  "error": "Not authorized"
}

​
404 Not Found

Returned when the user ID doesn’t exist: 
{
  "detail": "Not found."
}

​
500 Internal Server Error

Returned when an unexpected error occurs: 
{
  "error": "Error message details"
}

​
Example Requests

​
Update Basic Information (JSON)

curl -X PUT https://api.example.com/api/profile/42/update/ \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Alice",
    "last_name": "Wonderland",
    "number_phone": "5559876543"
  }'

​
Update with Avatar Upload (Multipart)

curl -X PUT https://api.example.com/api/profile/42/update/ \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -F "avatar=@profile_pic.jpg" \
  -F "first_name=Alice" \
  -F "last_name=Wonderland"

​
Partial Update (Single Field)

curl -X PUT https://api.example.com/api/profile/42/update/ \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

​
Example Response

{
  "id": 42,
  "username": "alice_wonder",
  "email": "[email protected]",
  "first_name": "Alice",
  "last_name": "Wonderland",
  "number_phone": "5559876543",
  "avatar": "/media/avatars/alice_updated.jpg",
  "date_joined": "2024-02-01T08:15:30Z",
  "last_login": "2024-03-10T11:45:22Z",
  "is_active": true,
  "is_staff": false,
  "is_superuser": false
}

​
Implementation Details

This endpoint is implemented in /apps/users/views.py:97 as the update_profile function view:
  • Decorated with @permission_classes([IsAuthenticated]) to require authentication
  • Verifies that request.user matches the user being updated (authorization check)
  • Supports MultiPartParser and FormParser for file uploads
  • Handles avatar file uploads separately before serializer validation
  • Uses UsersSerializer with partial=True to allow partial updates
  • Returns updated user data on success

​
Notes

  • Partial updates are supported - you only need to include fields you want to change
  • Avatar images are uploaded to the media/avatars/ directory
  • Email and username must remain unique across all users
  • The endpoint uses PUT method but supports partial updates (PATCH-like behavior)

Build docs developers (and LLMs) love

Get started for freeTalk to us