Users

Update the user's avatar

Replaces this user's avatar. Send a file, avatar_url, or avatar_base64.

post/users/{id}/update-avatar

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/users/{id}/update-avatar
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:services

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: city, city.location, place, place.location, location, services.

Request body

avatar_urlstring uri

Publicly reachable http(s) URL of the avatar image to fetch and attach. Prefer this when the image already lives somewhere addressable.

avatar_base64string

Base64-encoded image bytes (optionally a "data:...;base64," URI). Use when you hold raw bytes and have no URL.

Response

Success. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "user"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.