Sign in

v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Settings

Update Profile

Updates the account profile. Only include the fields you want to update. To make a field empty, set it to null.

post/api/{account}/settings/profile

Request body

usernamestring

The new username to use. Make sure to first check if it exists using our /settings/username-exists endpoint.

namestring nullable

The new display name to use. Set to null to use the default display name.

avatarstring

The new avatar to use. Must be a ofapi_media_ ID. Refer to our /media/upload endpoint on how to get this.

headerstring

The new header (banner) to use. Must be a ofapi_media_ ID. Refer to our /media/upload endpoint on how to get this.

aboutstring nullable

The new bio to use. Set to null to empty it.

locationstring nullable

The new location to use. Set to null to empty it.

websitestring nullable

The new website URL to use. Must be a valid URL. Set to null to empty it.

wishliststring nullable

The new Amazon Wishlist URL to use. Must be a valid URL. Set to null to empty it.

Example request

{
  "username": "MyNewUsername",
  "name": "u1234",
  "avatar": "ofapi_media_abc123",
  "header": "ofapi_media_abc123",
  "about": "Hey there!",
  "location": "Europe",
  "website": "https://example.com",
  "wishlist": "https://example.com"
}

Response

Success

Example response

{
  "data": {
    "success": true
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999969,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 10000000,
      "limit_day": 50000,
      "remaining_minute": 9999998,
      "remaining_day": 49970
    }
  }
}