API · profile

Update profile photo

PATCH /api/v2/profile/photo

Authorization

Authenticated user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

Name	Type	Contract
avatar	string or null · required	JPEG data URL under 150 KB; null removes photo

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example

inboxit profile photo --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example

{
  "avatar": null
}

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example

{
  "display_name": "Your Name",
  "avatar": null
}

Behavior & errors

JPEG signature is checked. No PNG upload or multipart endpoint. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.