Skip to content

avatar

Accessed as client.user.avatar; the async client mirrors it.

UserAvatar

The user.avatar namespace.

delete

delete() -> None

Delete avatar of the current user. It will be replaced by a default one.

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userDeleteAvatar

update

update(*, image: str | None = None) -> None

Update avatar of the current user.

Parameters:

Name Type Description Default
image str | None

image must be base64 encoded

None

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userUpdateAvatar

AsyncUserAvatar

The user.avatar namespace.

delete

delete() -> None

Delete avatar of the current user. It will be replaced by a default one.

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userDeleteAvatar

update

update(*, image: str | None = None) -> None

Update avatar of the current user.

Parameters:

Name Type Description Default
image str | None

image must be base64 encoded

None

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userUpdateAvatar