pl-api
    Preparing search index...

    Interface AdminAccountUpdateCredentialsParams

    interface AdminAccountUpdateCredentialsParams {
        actor_type?: "Service" | "Person";
        allow_following_move?: boolean;
        avatar?: "" | File;
        bio?: string;
        default_scope?: string;
        discoverable?: boolean;
        email?: string;
        fields?: Record<string, { name: string; value: string }>;
        header?: "" | File;
        hide_favorites?: boolean;
        hide_followers?: boolean;
        hide_followers_count?: boolean;
        hide_follows?: boolean;
        hide_follows_count?: boolean;
        locked?: boolean;
        name?: string;
        no_rich_text?: boolean;
        password?: string;
        show_role?: boolean;
        skip_thread_containment?: boolean;
    }
    Index

    Properties

    actor_type? allow_following_move? avatar? bio? default_scope? discoverable? email? fields? header? hide_favorites? hide_followers? hide_followers_count? hide_follows? hide_follows_count? locked? name? no_rich_text? password? show_role? skip_thread_containment?

    Properties

    actor_type?: "Service" | "Person"
    allow_following_move?: boolean

    if true, allows automatically follow moved following accounts

    avatar?: "" | File

    Avatar image encoded using multipart/form-data

    bio?: string

    String. The account bio.

    default_scope?: string

    the scope returned under privacy key in Source subentity

    discoverable?: boolean

    Boolean. Whether the account should be shown in the profile directory. Requires featuresFeatures.accountDiscoverability

    email?: string
    fields?: Record<string, { name: string; value: string }>

    Hash. The profile fields to be set. Inside this hash, the key is an integer cast to a string (although the exact integer does not matter), and the value is another hash including name and value. By default, max 4 fields.

    header?: "" | File

    Header image encoded using multipart/form-data

    hide_favorites?: boolean

    if true, user's favorites timeline will be hidden

    hide_followers?: boolean

    if true, user's followers will be hidden

    hide_followers_count?: boolean

    if true, user's follower count will be hidden

    hide_follows?: boolean

    if true, user's follows will be hidden

    hide_follows_count?: boolean

    if true, user's follow count will be hidden

    locked?: boolean

    Boolean. Whether manual approval of follow requests is required.

    name?: string

    String. The display name to use for the profile.

    Optionalno_rich_text

    no_rich_text?: boolean

    if true, html tags are stripped from all statuses requested from the API

    password?: string
    show_role?: boolean

    if true, user's role (e.g admin, moderator) will be exposed to anyone in the API

    skip_thread_containment?: boolean

    if true, skip filtering out broken threads

    Settings

    Member Visibility

    On This Page

    Properties