Skip to content

UpdateCredentialsRequest

A change of the profile; properties left out keep their current values.

object
display_name

The display name, at most 30 characters; empty removes it.

string
note

The profile text as plain text, at most 500 characters; empty removes it.

string
fields

The metadata fields, replacing the current ones; at most 4.

Array<object>

A metadata field of a profile as the user typed it.

object
name
required

The label, at most 255 characters.

string
value
required

The value as plain text, at most 255 characters.

string
avatar_media_id

The ID of a processed image that the user uploaded, to become the avatar; empty removes the avatar.

string
header_media_id

The ID of a processed image that the user uploaded, to become the header image; empty removes the header image.

string
locked

Whether follow requests need the user’s approval.

boolean
bot

Whether the account is automated.

boolean
discoverable

Whether the account is suggested to others and found by the middle of its names in the account search; when false, the search finds it only by its whole username. New accounts are discoverable.

boolean
indexable

Whether the account’s profile and public posts may be indexed for search.

boolean
ai_opt_out

Whether the account’s pages state that AI may neither train on nor use them.

boolean
feed_enabled

Whether the Atom feed of the account’s public posts may be served. Setting it makes the owner’s choice, which a later change of indexable leaves as it is.

boolean
follows_visibility

Who may read an account’s follows and followers lists (GET /accounts/{id}/following and GET /accounts/{id}/followers): public, everyone; followers, the accounts whose follow of it is approved; private, nobody. The owner always reads both, and the counts (following_count, followers_count) stay visible to everyone. Other servers see the number of follows and followers alone unless the lists are public.

string
Allowed values: public followers private

Example generated

{
"display_name": "example",
"note": "example",
"fields": [
{
"name": "example",
"value": "example"
}
],
"avatar_media_id": "example",
"header_media_id": "example",
"locked": true,
"bot": true,
"discoverable": true,
"indexable": true,
"ai_opt_out": true,
"feed_enabled": true,
"follows_visibility": "public"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site