Update admin avatar image

PUT 
/v2/onboard/admin/avatarimage

Updates the avatar image of the admin that the API key belongs to. Send the image as multipart/form-data in the avatarimage field: a PNG, JPEG, GIF or WebP image of at most 5 MiB and 4096 x 4096 pixels. The answer is a flat object with no wrapper.

Request

multipart/form-data

Body

required

avatarimage binaryrequired

The new avatar image.

Responses

200

The service updated the avatar image.

application/json

Schema

Schema

id string

The identifier of the admin.

email string

The e-mail address of the admin.

name string

The name of the admin.

avatarImageId string

The identifier of the new avatar image.

avatarImageUrl string

The URL of the avatar image.

lastVisited string

The date and time of the last login of the admin.

Example (from schema)

{
  "id": "6a1f0c2e9b3d4e5f6a7b8c9d",
  "email": "[email protected]",
  "name": "Jane Doe",
  "avatarImageId": "6a1f0c2e9b3d4e5f6a7b8c9e",
  "avatarImageUrl": "https://demo-api.igrant.io/onboard/admin/avatarimage",
  "lastVisited": "2026-10-27T09:12:44Z"
}

400

The file is not a readable PNG, JPEG, GIF or WebP image, or it is larger than 4096 x 4096 pixels.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

413

The image is larger than 5 MiB.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...