Upload or replace your profile picture

POST

///api/v1/users/me/avatar

POST

/api/v1/users/me/avatar

$ curl -X POST /api/v1/users/me/avatar \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F file=@"[object Object]"

1 {
2   "id": "string",
3   "email": "string",
4   "has_avatar": true,
5   "is_active": true,
6   "is_superuser": false,
7   "is_verified": false,
8   "tenant_id": "string",
9   "is_2fa_enabled": false,
10   "last_login_at": "2024-01-15T09:30:00Z",
11   "first_name": "string",
12   "last_name": "string",
13   "phone": "string",
14   "job_title": "string",
15   "timezone": "string",
16   "language": "string",
17   "onboarding_completed": false,
18   "modules": [
19     "string"
20   ],
21   "tenant_slug": "string",
22   "tenant_name": "string",
23   "memberships": [
24     {
25       "id": "string",
26       "tenant_id": "string",
27       "status": "string",
28       "is_default": true,
29       "tenant_slug": "string",
30       "tenant_name": "string",
31       "joined_at": "2024-01-15T09:30:00Z"
32     }
33   ],
34   "platform_role": "string",
35   "is_owner": false,
36   "effective_permissions": [
37     "string"
38   ],
39   "is_impersonated": false,
40   "original_actor_id": "string",
41   "avatar_key": "string"
42 }

Accept a profile picture upload (PNG/JPEG/WebP, max 5 MB).

Deletes any previous avatar from storage before writing the new one.
Returns the full UserRead response with has_avatar=True.

Accept a profile picture upload (PNG/JPEG/WebP, max 5 MB). - Deletes any previous avatar from storage before writing the new one. - Returns the full UserRead response with ``has_avatar=True``.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Response

Successful Response

idstringformat: "uuid"

emailstringformat: "email"

has_avatarbooleanRead-only

is_activebooleanOptionalDefaults to true

is_superuserbooleanOptionalDefaults to false

is_verifiedbooleanOptionalDefaults to false

tenant_idstring or nullOptionalformat: "uuid"

is_2fa_enabledbooleanOptionalDefaults to false

last_login_atdatetime or nullOptional

first_namestring or nullOptional

last_namestring or nullOptional

phonestring or nullOptional

job_titlestring or nullOptional

timezonestring or nullOptionalDefaults to UTC

languagestring or nullOptionalDefaults to en

onboarding_completedbooleanOptionalDefaults to false

moduleslist of stringsOptionalDefaults to []

tenant_slugstring or nullOptional

tenant_namestring or nullOptional

membershipslist of objectsOptionalDefaults to []

platform_rolestring or nullOptional

is_ownerbooleanOptionalDefaults to false

effective_permissionslist of stringsOptionalDefaults to []

is_impersonatedbooleanOptionalDefaults to false

original_actor_idstring or nullOptional

avatar_keystring or nullOptional

Errors

422

Unprocessable Entity Error