latestOpenAPI 3.1.02026-08-1051813.2 KB

a38c15dd49ef

Profile

Upserts a user's profile

Updates the profile of the user making the request. If the user does not have a profile, one will be created. The profile picture and avatar of a user can be unset using this endpoint.

The endpoint accepts a JSON object as body, which allows upserting various fields of the user's profile. An image from the user's collection can be set a profile picture by sending its datasource and object definition IDs in the body.

The endpoint also accepts a file (image) in binary format as body, which will be uploaded and saved as the user's profile picture. The Content-Type header has to be set to 'multipart/form-data' when sending a file.

put/

Headers

x-m2-organization-idstring required

The ID of an organization

Request body

usernamestring

The username of a user. It might have restricted length and characters, based on the organization's settings.

{"stackTrail":"components:schemas:putProfileRequestSchema:properties:profilePicture","oasType":"schema","type":"unknown","description":"This field is populated by a middleware when a file is sent as body. It should not be set by the client."}

Response

The user's profile after upserting it.

usernamestring

profilePictureUrlstring