Update Profile
curl --request PATCH \
--url https://relay.snipp.gg/users/{id} \
--header 'Content-Type: application/json' \
--header 'relay-key: <api-key>' \
--data '
{
"bio": "Shipping clips daily",
"nickname": "P1"
}
'import requests
url = "https://relay.snipp.gg/users/{id}"
payload = {
"bio": "Shipping clips daily",
"nickname": "P1"
}
headers = {
"relay-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'relay-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({bio: 'Shipping clips daily', nickname: 'P1'})
};
fetch('https://relay.snipp.gg/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://relay.snipp.gg/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'bio' => 'Shipping clips daily',
'nickname' => 'P1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"relay-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://relay.snipp.gg/users/{id}"
payload := strings.NewReader("{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("relay-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://relay.snipp.gg/users/{id}")
.header("relay-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://relay.snipp.gg/users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["relay-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "123456789012345678",
"username": "playerone",
"nickname": "P1",
"avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
"banner": "https://i.snipp.gg/banners/123456789012345678/1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f.png",
"bio": "Shipping clips daily",
"socials": {
"github": "https://github.com/playerone"
},
"plan": "plus",
"verified": false,
"staff": false,
"partner": false,
"translator": false,
"bug_hunter_tier": 0,
"suspended": false,
"created_at": "2026-01-04T09:30:00.000Z",
"custom_embed": null,
"follower_count": 128,
"following_count": 47,
"following": false,
"blocking": false,
"api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
"key_has_uploads_access": true,
"relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
"upload_count": 42,
"limits": {
"max_file_size": 21474836480,
"usage": {
"used": 1073741824,
"limit": 21474836480,
"used_percent": 5,
"resets_at": "2026-10-04T16:20:00.000Z"
},
"priority_minutes": {
"used": 12,
"limit": 100,
"used_percent": 12,
"resets_at": "2026-10-19T16:20:00.000Z"
}
},
"theme": "pastel_blue",
"subscription": {
"status": "active",
"started_at": "2026-01-04T09:30:00.000Z",
"expires_at": "2026-11-04T09:30:00.000Z",
"cancel_at_period_end": false,
"gifted": false
}
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}Users
Update Profile
Update your own profile. id must be @me or your own ID. Send only the fields you want to change.
PATCH
/
users
/
{id}
Update Profile
curl --request PATCH \
--url https://relay.snipp.gg/users/{id} \
--header 'Content-Type: application/json' \
--header 'relay-key: <api-key>' \
--data '
{
"bio": "Shipping clips daily",
"nickname": "P1"
}
'import requests
url = "https://relay.snipp.gg/users/{id}"
payload = {
"bio": "Shipping clips daily",
"nickname": "P1"
}
headers = {
"relay-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'relay-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({bio: 'Shipping clips daily', nickname: 'P1'})
};
fetch('https://relay.snipp.gg/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://relay.snipp.gg/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'bio' => 'Shipping clips daily',
'nickname' => 'P1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"relay-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://relay.snipp.gg/users/{id}"
payload := strings.NewReader("{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("relay-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://relay.snipp.gg/users/{id}")
.header("relay-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://relay.snipp.gg/users/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["relay-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bio\": \"Shipping clips daily\",\n \"nickname\": \"P1\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "123456789012345678",
"username": "playerone",
"nickname": "P1",
"avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
"banner": "https://i.snipp.gg/banners/123456789012345678/1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f.png",
"bio": "Shipping clips daily",
"socials": {
"github": "https://github.com/playerone"
},
"plan": "plus",
"verified": false,
"staff": false,
"partner": false,
"translator": false,
"bug_hunter_tier": 0,
"suspended": false,
"created_at": "2026-01-04T09:30:00.000Z",
"custom_embed": null,
"follower_count": 128,
"following_count": 47,
"following": false,
"blocking": false,
"api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
"key_has_uploads_access": true,
"relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
"upload_count": 42,
"limits": {
"max_file_size": 21474836480,
"usage": {
"used": 1073741824,
"limit": 21474836480,
"used_percent": 5,
"resets_at": "2026-10-04T16:20:00.000Z"
},
"priority_minutes": {
"used": 12,
"limit": 100,
"used_percent": 12,
"resets_at": "2026-10-19T16:20:00.000Z"
}
},
"theme": "pastel_blue",
"subscription": {
"status": "active",
"started_at": "2026-01-04T09:30:00.000Z",
"expires_at": "2026-11-04T09:30:00.000Z",
"cancel_at_period_end": false,
"gifted": false
}
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"username": "<string>",
"quota": 123,
"used": 123,
"resets_at": "2023-11-07T05:31:56Z",
"failed": [
{
"index": 123,
"error": "<unknown>"
}
]
}
}Update your own profile.
id must be @me or your own ID. Send only the fields you want to change.
Body
| Field | Type | Description |
|---|---|---|
username | string | 4 to 15 characters: letters, numbers and underscores. Must not be taken (case-insensitive). |
nickname | string or null | Up to 15 characters. "" or null clears it. |
bio | string or null | Up to 200 characters. "" or null clears it. |
socials | object | Keyed by roblox, github, spotify, youtube, tiktok, X, bluesky, discord. Replaces the whole set; an empty object clears it. null changes nothing. |
custom_embed | object or null | Plus only. null or {} clears it. |
theme | string | Accent theme key. Plus only. |
Behavior
- Send a JSON body. A body with nothing to change returns
400. - Each
socialsvalue must be a link on that platform’s domain.discordalso accepts a bare Discord user ID. custom_embedfields:title(up to 60 characters) anddescription(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.
thememust be one ofred,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_roseordynamic. It is only visible to you.- On Free, sending
theme, orcustom_embedas anything butnull, returns403with typeplan_required. Free accounts can still clear an embed withnull. avatarandbannerare not accepted here; use Upload Avatar and Upload Banner.emailcan only be changed on the website. Both return400.- 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
curl -X PATCH "https://relay.snipp.gg/users/@me" \
-H "relay-key: YOUR_RELAY_KEY" \
-H "Content-Type: application/json" \
-d '{"bio": "Shipping clips daily", "nickname": "P1"}'
curl -X PATCH "https://relay.snipp.gg/users/@me" \
-H "relay-key: YOUR_RELAY_KEY" \
-H "Content-Type: application/json" \
-d '{"theme": "pastel_blue"}'
Responses
{
"user": {
"id": "123456789012345678",
"username": "playerone",
"nickname": "P1",
"avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
"banner": "https://i.snipp.gg/banners/123456789012345678/1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f.png",
"bio": "Shipping clips daily",
"socials": {
"github": "https://github.com/playerone"
},
"plan": "plus",
"verified": false,
"staff": false,
"partner": false,
"translator": false,
"bug_hunter_tier": 0,
"suspended": false,
"created_at": "2026-01-04T09:30:00.000Z",
"custom_embed": null,
"follower_count": 128,
"following_count": 47,
"following": false,
"blocking": false,
"api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
"key_has_uploads_access": true,
"relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
"upload_count": 42,
"limits": {
"max_file_size": 21474836480,
"usage": {
"used": 1073741824,
"limit": 21474836480,
"used_percent": 5,
"resets_at": "2026-10-04T16:20:00.000Z"
},
"priority_minutes": {
"used": 12,
"limit": 100,
"used_percent": 12,
"resets_at": "2026-10-19T16:20:00.000Z"
}
},
"theme": "pastel_blue",
"subscription": {
"status": "active",
"started_at": "2026-01-04T09:30:00.000Z",
"expires_at": "2026-11-04T09:30:00.000Z",
"cancel_at_period_end": false,
"gifted": false
}
}
}
Errors
| Status | Type | When |
|---|---|---|
400 | invalid_request | Nothing to change, an invalid or taken value, or avatar, banner or email in the body |
401 | unauthorized | Missing or invalid key |
403 | forbidden | id is not you |
403 | plan_required | theme or custom_embed without Plus |
403 | suspended | A suspended account changing username, nickname or bio |
429 | rate_limited | More than 10 requests per minute |
Authorizations
Your relay key from snipp.gg/settings/relay
Path Parameters
User ID, or @me for your own account.
Body
application/json
4 to 15 characters: letters, numbers, underscores.
Maximum string length:
15Maximum string length:
200Show child attributes
Show child attributes
Custom embed settings. Keys are omitted when unset.
Show child attributes
Show child attributes
Accent theme key. Plus only.
Response
Success
Returned for @me or your own ID.
Show child attributes
Show child attributes