Update an appliance-local account profile

PATCH/v1/account/profile

Persist a display name and/or profile image for an on-prem account.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
None.

Body schema

Content type: application/json · Required

FieldTypeRequiredDescription
displayNamestringNo
photoURLstringNoAppliance uploads accept a JPEG, PNG, or WebP data URL; an empty value removes the image.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Updated account profileapplication/json
FieldTypeRequiredDescription
userIdstringYesUser ID.
emailstringYes
displayNamestringYes
photoURLstringYes
profileobjectYes
profile.displayNamestringYes
profile.photoURLstringYes
400Invalid profile update
None.
404Local profile management is unavailable or the user was not found
None.
413Profile image exceeds the upload limit
None.
Update an appliance-local account profile
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow