AUautomattic
avatars

Upload new avatar image

Changed on

Uploads a new avatar image for the authenticated user.

post/me/avatars

Request

Query parameters

selected_email_hashstring

The SHA256 hash of email. If provided, the uploaded image will be selected as the avatar for this email.

select_avatarboolean nullable

Determines if the uploaded image should be set as the avatar for the email. If not passed, the image is only selected as the email's avatar if no previous avatar has been set. Accepts '1'/'true' to always set the avatar or '0'/'false' to never set the avatar.

Request body multipart/form-data

imagestring binary required

The avatar image file

Response

Avatar uploaded successfully

image_idstring required

Unique identifier for the image.

image_urlstring uri required

Image URL

rating'G' | 'PG' | 'R' | 'X' required

Rating associated with the image.

alt_textstring required

Alternative text description of the image.

selectedboolean

Whether the image is currently selected as the provided selected email's avatar.

updated_datestring date-time required

Date and time when the image was last updated.

Example response

{
  "image_id": "38be15a98a2bbc40df69172a2a8349",
  "image_url": "https://gravatar.com/userimage/252014526/d38bele5a98a2bbc40df69172a2a8348.jpeg",
  "alt_text": "Gravatar's avatar image. Gravatar is a service for providing globally unique avatars.",
  "selected": true,
  "updated_date": "2021-10-01T12:00:00Z"
}

Changes

  • 4834d59bad15Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

  • 3f198beeabbfRevision changes
    • info

      added the new optional query request parameter select_avatar

    • info

      added the new optional query request parameter selected_email_hash