pl-api
    Preparing search index...

    Interface UpdateCredentialsParams

    interface UpdateCredentialsParams {
        accepts_chat_messages?: boolean;
        actor_type?: string;
        allow_following_move?: boolean;
        also_known_as?: string[];
        avatar?: "" | File;
        avatar_description?: string;
        background_image?: string;
        bot?: boolean;
        custom_css?: string;
        default_scope?: string;
        discoverable?: boolean;
        display_name?: string;
        enable_rss?: boolean;
        fields_attributes?: Record<string, { name: string; value: string }>;
        header?: "" | File;
        header_description?: string;
        hide_collections?: boolean;
        hide_favorites?: boolean;
        hide_followers?: boolean;
        hide_followers_count?: boolean;
        hide_follows?: boolean;
        hide_follows_count?: boolean;
        indexable?: boolean;
        is_cat?: boolean;
        language?: string;
        locked?: boolean;
        mention_policy?: "none" | "only_known" | "only_contacts";
        no_rich_text?: boolean;
        note?: string;
        settings_store?: Record<string, any>;
        show_role?: boolean;
        skip_thread_containment?: boolean;
        source?: { language?: string; privacy?: string; sensitive?: boolean };
        speak_as_cat?: boolean;
        web_layout?: "microblog" | "gallery";
        web_visibility?: "none" | "public" | "unlisted";
    }
    Index

    Properties

    accepts_chat_messages? actor_type? allow_following_move? also_known_as? avatar? avatar_description? background_image? bot? custom_css? default_scope? discoverable? display_name? enable_rss? fields_attributes? header? header_description? hide_collections? hide_favorites? hide_followers? hide_followers_count? hide_follows? hide_follows_count? indexable? is_cat? language? locked? mention_policy? no_rich_text? note? settings_store? show_role? skip_thread_containment? source? speak_as_cat? web_layout? web_visibility?

    Properties

    accepts_chat_messages?: boolean

    if false, this account will reject all chat messages.

    actor_type?: string

    the type of this account.

    allow_following_move?: boolean

    if true, allows automatically follow moved following accounts

    also_known_as?: string[]

    array of ActivityPub IDs, needed for following move

    avatar?: "" | File

    Avatar image encoded using multipart/form-data

    avatar_description?: string

    Description of avatar image, for alt-text.

    Requires featuresFeatures.accountAvatarDescription.

    background_image?: string

    sets the background image of the user. Can be set to "" (an empty string) to reset.

    bot?: boolean

    Boolean. Whether the account has a bot flag.

    custom_css?: string

    Custom CSS to use when rendering this account's profile or statuses. String must be no more than 5,000 characters (~5kb). Requires instance.configuration.accounts.allow_custom_css.

    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

    display_name?: string

    String. The display name to use for the profile.

    enable_rss?: boolean

    Enable RSS feed for this account's Public posts at /[username]/feed.rss Requires featuresFeatures.accountEnableRss.

    fields_attributes?: 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

    header_description?: string

    Description of header image, for alt-text. Requires featuresFeatures.accountAvatarDescription.

    hide_collections?: boolean

    Boolean. Whether to hide followers and followed accounts.

    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

    indexable?: boolean

    Boolean. Whether public posts should be searchable to anyone.

    is_cat?: boolean

    Whether the user is a cat

    language?: string

    user's preferred language for receiving emails (digest, confirmation, etc.)

    locked?: boolean

    Boolean. Whether manual approval of follow requests is required.

    mention_policy?: "none" | "only_known" | "only_contacts"

    Mention policy Required featuresFeatures.accountMentionPolicy.

    Optionalno_rich_text

    no_rich_text?: boolean

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

    note?: string

    String. The account bio.

    settings_store?: Record<string, any>

    Opaque user settings to be saved on the backend.

    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

    source?: { language?: string; privacy?: string; sensitive?: boolean }

    Type declaration

    • Optionallanguage?: string

      String. Default language to use for authored statuses (ISO 6391)

    • Optionalprivacy?: string

      String. Default post privacy for authored statuses. Can be public, unlisted, or private.

    • Optionalsensitive?: boolean

      Boolean. Whether to mark authored statuses as sensitive by default.

    speak_as_cat?: boolean

    Whether the user speaks as a cat

    web_layout?: "microblog" | "gallery"

    Layout to use for the web view of the account.

    • microblog: default, classic microblog layout.
    • gallery: gallery layout with media only. Requires featuresFeatures.accountWebLayout.
    web_visibility?: "none" | "public" | "unlisted"

    Posts to show on the web view of the account.

    • public: default, show only Public visibility posts on the web.
    • unlisted: show Public and Unlisted visibility posts on the web.
    • none: show no posts on the web, not even Public ones. Requires featuresFeatures.accountWebVisibility.

    Settings

    Member Visibility

    On This Page

    Properties