Skip to main content
User Management

Update admin avatar image

PUT/v4/onboard/platform/admin/avatarimage

Replaces the avatar image of the admin who makes the call. Send the image as multipart/form-data in the avatarimage field: a PNG, JPEG, GIF or WebP image (the service reads the type from the bytes) of at most 5 MiB and 4096 x 4096 pixels (the defaults of the installation). Get the image back with Read admin avatar image. The answer is a flat object with no wrapper member.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:admin-profile:update

Body

multipart/form-data
  • avatarimagefilerequired

    The image file (PNG, JPEG, GIF or WebP).

Response

application/json

The admin with the new avatar image.

  • idstring

    The id of the admin.

  • emailstring

    The email address with which the admin signs in.

  • namestring

    The display name of the admin.

  • avatarImageIdstring

    The id of the new avatar image.

  • avatarImageUrlstring

    The URL that the service stored with the new image (https://{api host}/onboard/admin/avatarimage). No route of the API answers on this URL: get the image with Read admin avatar image.

  • lastSignInstring

    When the admin last signed in (RFC 3339, UTC). An empty string when the admin has not signed in since the platform started to record it.