> ## Documentation Index
> Fetch the complete documentation index at: https://docs.evolutionfoundation.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Update user profile

> Update current user profile information



## OpenAPI

````yaml /api-reference/openapi/Evo-Auth-Service/profile.yaml put /api/v1/profile
openapi: 3.0.1
info:
  title: Evolution Foundation - Auth Service - Profile
  description: Authentication and user and account management
  version: v1.0.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3001
    description: Development server
    variables:
      port:
        default: '3001'
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /api/v1/profile:
    put:
      summary: Update user profile
      description: Update current user profile information
      operationId: updateProfile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: User full name
                  example: John Doe
                email:
                  type: string
                  format: email
                  description: User email address
                  example: john.doe@example.com
                display_name:
                  type: string
                  description: User display name
                  example: John
                message_signature:
                  type: string
                  description: Email signature
                  example: Best regards, John
                custom_attributes:
                  type: object
                  additionalProperties: true
                  description: Custom user attributes
                ui_settings:
                  type: object
                  additionalProperties: true
                  description: UI preferences and settings
                avatar:
                  type: string
                  format: binary
                  description: Avatar image file (base64 encoded or URL)
      responses:
        '200':
          description: Profile updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/UserProfile'
                  meta:
                    type: object
                    properties:
                      timestamp:
                        type: string
                        format: date-time
                        description: Response timestamp
                        example: '2026-01-28T22:32:23Z'
                  message:
                    type: string
                    description: Success message
                    example: Profile updated successfully
        '400':
          description: Bad Request (invalid data)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation_error:
                  summary: Invalid request parameters
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid request parameters
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
                invalid_email:
                  summary: Invalid email format
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Invalid email format
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
        '401':
          description: Unauthorized (invalid or missing token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Unauthorized access
                  value:
                    success: false
                    error:
                      code: INVALID_TOKEN
                      message: Invalid token
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
        '403':
          description: Forbidden (insufficient permissions)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: Access forbidden
                  value:
                    success: false
                    error:
                      code: FORBIDDEN
                      message: You do not have permission to access this resource
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
        '404':
          description: Not Found (resource not found)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: Profile not found
                  value:
                    success: false
                    error:
                      code: NOT_FOUND
                      message: User profile not found
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
        '422':
          description: Unprocessable Entity (validation errors)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation_errors:
                  summary: Validation errors
                  value:
                    success: false
                    error:
                      code: VALIDATION_ERROR
                      message: Validation failed
                      details:
                        email:
                          - has already been taken
                          - is invalid
                        name:
                          - is too short (minimum is 2 characters)
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
        '500':
          description: Internal Server Error (server error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal_error:
                  summary: Internal server error
                  value:
                    success: false
                    error:
                      code: INTERNAL_ERROR
                      message: An unexpected error occurred
                    meta:
                      timestamp: '2024-01-15T10:30:00Z'
                      path: /api/v1/profile
                      method: PUT
      security:
        - ApiAccessTokenAuth: []
components:
  schemas:
    UserProfile:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User unique identifier
        name:
          type: string
          description: User full name
        email:
          type: string
          format: email
          description: User email address
        type:
          type: string
          enum:
            - User
            - SuperAdmin
          description: User type
        role:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            key:
              type: string
            name:
              type: string
          description: User role information
        pubsub_token:
          type: string
          description: Token for real-time communication
        display_name:
          type: string
          nullable: true
          description: User display name
        available_name:
          type: string
          description: Name or email fallback
        availability:
          type: string
          enum:
            - online
            - busy
            - offline
          description: User availability status
        mfa_enabled:
          type: boolean
          description: Whether MFA is enabled
        confirmed:
          type: boolean
          description: Whether email is confirmed
        confirmed_at:
          type: string
          format: date-time
          nullable: true
          description: Email confirmation timestamp
        avatar_url:
          type: string
          nullable: true
          description: URL to user avatar
        custom_attributes:
          type: object
          additionalProperties: true
          description: Custom user attributes
        ui_settings:
          type: object
          additionalProperties: true
          description: User interface settings
        is_super_admin:
          type: boolean
          description: Whether user is super admin
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
    ErrorResponse:
      type: object
      required:
        - success
        - error
        - meta
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Validation failed
            details:
              type: object
              additionalProperties: true
              nullable: true
        meta:
          type: object
          required:
            - timestamp
            - path
            - method
          properties:
            timestamp:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
            path:
              type: string
              example: /api/v1/super_admin/accounts/123
            method:
              type: string
              example: POST
  securitySchemes:
    ApiAccessTokenAuth:
      type: apiKey
      in: header
      name: api_access_token
      description: API access token authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.