Interface UpdateCredentialsParams

interface UpdateCredentialsParams {
    avatar?: null | string | Blob;
    bot?: boolean;
    discoverable?: boolean;
    displayName?: null | string;
    fieldsAttributes?: null | AccountField[];
    header?: null | string | Blob;
    hideCollections?: null | boolean;
    locked?: null | boolean;
    note?: null | string;
    source?:
        | null
        | Partial<Pick<AccountSource, "sensitive" | "language" | "privacy">>;
}

Properties

avatar? bot? discoverable? displayName? fieldsAttributes? header? hideCollections? locked? note? source?

Properties

Optional Readonlyavatar

avatar?: null | string | Blob

Avatar image encoded using multipart/form-data

Optional Readonlybot

bot?: boolean

Whether the account has a bot flag.

Optional Readonlydiscoverable

discoverable?: boolean

Whether the account should be shown in the profile directory.

Optional ReadonlydisplayName

displayName?: null | string

The display name to use for the profile.

Optional ReadonlyfieldsAttributes

fieldsAttributes?: null | AccountField[]

Profile metadata name and value. (By default, max 4 fields and 255 characters per property/value)

Optional Readonlyheader

header?: null | string | Blob

Header image encoded using multipart/form-data

Optional ReadonlyhideCollections

hideCollections?: null | boolean

Whether you want to hide followers and followings on your profile

Optional Readonlylocked

locked?: null | boolean

Whether manual approval of follow requests is required.

Optional Readonlynote

note?: null | string

The account bio.

Optional Readonlysource

source?:
    | null
    | Partial<Pick<AccountSource, "sensitive" | "language" | "privacy">>

Settings

Member Visibility

On This Page

Properties