Skip to main content
PATCH
Update Profile
Update your own profile. id must be @me or your own ID. Send only the fields you want to change.

Body

Behavior

  • Send a JSON body. A body with nothing to change returns 400.
  • Each socials value must be a link on that platform’s domain. discord also accepts a bare Discord user ID.
  • custom_embed fields:
    • title (up to 60 characters) and description (up to 200): templates that accept %{post_title}%, %{post_description}%, %{username}% and %{nickname}%.
    • theme_color: a hex color such as #F0B100.
    • small_text (up to 50): the small site name line.
  • theme must be one of red, orange, amber, yellow, pastel_yellow, pastel_orange, lime, light_green, slime, green, emerald, teal, ice, cyan, sky, pastel_blue, blue, midnight_blue, indigo, light_violet, violet, purple, magenta, fuchsia, pastel_purple, light_pink, pink, rose, dark_rose or dynamic. It is only visible to you.
  • On Free, sending theme, or custom_embed as anything but null, returns 403 with type plan_required. Free accounts can still clear an embed with null.
  • avatar and banner are not accepted here; use Upload Avatar and Upload Banner. email can only be changed on the website. Both return 400.
  • A suspended account cannot change its username, nickname or bio.
  • The response is your full account, as returned by GET /users/@me.
  • Rate limited to 10 requests per minute.

Examples

Responses

Errors

Authorizations

relay-key
string
header
required

Your relay key from snipp.gg/settings/relay

Path Parameters

id
string
required

User ID, or @me for your own account.

Body

application/json
username
string

4 to 15 characters: letters, numbers, underscores.

nickname
string | null
Maximum string length: 15
bio
string | null
Maximum string length: 200
socials
object | null
custom_embed
object | null

Custom embed settings. Keys are omitted when unset.

theme
string

Accent theme key. Plus only.

Response

Success

user
object
required

Returned for @me or your own ID.