Update User

Update User

curl --request PATCH \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "username": "<string>",
  "avatar": "<string>",
  "bio": "<string>",
  "birthdate": "<string>",
  "location": {
    "latitude": 123,
    "longitude": 123
  },
  "metadata": {},
  "secureMetadata": {}
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId"

payload = {
    "name": "<string>",
    "username": "<string>",
    "avatar": "<string>",
    "bio": "<string>",
    "birthdate": "<string>",
    "location": {
        "latitude": 123,
        "longitude": 123
    },
    "metadata": {},
    "secureMetadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    username: '<string>',
    avatar: '<string>',
    bio: '<string>',
    birthdate: '<string>',
    location: {latitude: 123, longitude: 123},
    metadata: {},
    secureMetadata: {}
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId', 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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId",
  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([
    'name' => '<string>',
    'username' => '<string>',
    'avatar' => '<string>',
    'bio' => '<string>',
    'birthdate' => '<string>',
    'location' => [
        'latitude' => 123,
        'longitude' => 123
    ],
    'metadata' => [
        
    ],
    'secureMetadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "foreignId": {},
  "role": "<string>",
  "email": {},
  "name": {},
  "username": {},
  "avatar": {},
  "bio": {},
  "metadata": {},
  "reputation": {},
  "isVerified": {},
  "isActive": {},
  "lastActive": {},
  "suspensions": [
    {}
  ],
  "avatarFile": {},
  "bannerFile": {},
  "authMethods": [
    "<string>"
  ],
  "createdAt": "<string>"
}

PATCH

:projectId

api

users

:userId

Update User

curl --request PATCH \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "username": "<string>",
  "avatar": "<string>",
  "bio": "<string>",
  "birthdate": "<string>",
  "location": {
    "latitude": 123,
    "longitude": 123
  },
  "metadata": {},
  "secureMetadata": {}
}
'

import requests

url = "https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId"

payload = {
    "name": "<string>",
    "username": "<string>",
    "avatar": "<string>",
    "bio": "<string>",
    "birthdate": "<string>",
    "location": {
        "latitude": 123,
        "longitude": 123
    },
    "metadata": {},
    "secureMetadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    username: '<string>',
    avatar: '<string>',
    bio: '<string>',
    birthdate: '<string>',
    location: {latitude: 123, longitude: 123},
    metadata: {},
    secureMetadata: {}
  })
};

fetch('https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId', 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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId",
  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([
    'name' => '<string>',
    'username' => '<string>',
    'avatar' => '<string>',
    'bio' => '<string>',
    'birthdate' => '<string>',
    'location' => [
        'latitude' => 123,
        'longitude' => 123
    ],
    'metadata' => [
        
    ],
    'secureMetadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	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://api.sublay.io/api/v6/:projectId/api/v7/users/:userId")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sublay.io/api/v6/:projectId/api/v7/users/:userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"username\": \"<string>\",\n  \"avatar\": \"<string>\",\n  \"bio\": \"<string>\",\n  \"birthdate\": \"<string>\",\n  \"location\": {\n    \"latitude\": 123,\n    \"longitude\": 123\n  },\n  \"metadata\": {},\n  \"secureMetadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "foreignId": {},
  "role": "<string>",
  "email": {},
  "name": {},
  "username": {},
  "avatar": {},
  "bio": {},
  "metadata": {},
  "reputation": {},
  "isVerified": {},
  "isActive": {},
  "lastActive": {},
  "suspensions": [
    {}
  ],
  "avatarFile": {},
  "bannerFile": {},
  "authMethods": [
    "<string>"
  ],
  "createdAt": "<string>"
}

Updates one or more profile fields for the specified user. The requesting user must own the account, or use a service or master token to update any user. Supports direct image uploads for the avatar and banner via multipart/form-data. Uploaded images are processed, stored in Supabase, and the old files are automatically cleaned up after a successful update.

Send application/json for text-only updates. Use multipart/form-data when uploading image files.

Authentication

Requires a valid user auth token. The authenticated user must match :userId, or the request must carry a service/master token.

Path Parameters

string

required

The Sublay user ID (UUID) to update.

Body Parameters

All fields are optional. Only the fields provided are updated.

string

Display name.

string

New username. Automatically lowercased and sanitized. Returns 409 if already taken by another user.

string

URL of the user’s avatar image. Ignored if avatarFile is also provided.

string

Short bio text.

string

ISO 8601 datetime string for the user’s date of birth (e.g. "1990-06-15T00:00:00.000Z").

object

Geographic location stored as a PostGIS point.

Show properties

number

required

Latitude between -90 and 90.

number

required

Longitude between -180 and 180.

object

Public custom key-value data. Replaces the existing value.

object

Private custom key-value data. Not returned to other users. Replaces the existing value.

file

Avatar image file (multipart). Maximum 50 MB. Must be a valid image. Requires avatarFile.options to be present in the same request.

file

Banner image file (multipart). Maximum 50 MB. Must be a valid image. Requires bannerFile.options to be present in the same request.

Response

On success, returns HTTP 200 with the updated user’s authenticated profile:

string

Unique user ID (UUID).

string | null

External identifier from your system.

string

User role (e.g., "visitor").

string | null

User’s email address.

string | null

Updated display name.

string | null

Updated username.

string | null

Avatar URL.

string | null

Bio text.

object | null

Public custom key-value data.

number | null

Reputation score.

boolean | null

Whether the user’s email has been verified.

boolean | null

Whether the user account is active.

string | null

ISO timestamp of the user’s last activity.

array

Active suspensions on the account.

object | null

Processed avatar image with variants.

object | null

Processed banner image with variants.

string[]

Active auth methods (e.g., ["password", "google"]).

string

ISO timestamp of account creation.

When name, username, or bio changes, the user’s semantic search embedding is automatically updated asynchronously.

Error Responses

Not Authorized — 403

{
  "error": "Not authorized to update this user.",
  "code": "user/not-authorized"
}

User Not Found — 404

{
  "error": "User not found",
  "code": "user/not-found"
}

File Too Large — 413

{
  "message": "Avatar image exceeds 50MB limit.",
  "code": "user/file-too-large"
}

Invalid Image — 422

{
  "message": "Avatar file is not a valid image: ...",
  "code": "user/invalid-image"
}

Missing Image Options — 400

{
  "message": "Image options are required when uploading an avatar. Must include mode property.",
  "code": "user/missing-image-options"
}

Validation Failed — 400

{
  "error": "User validation failed",
  "code": "user/validation-failed"
}

Invalid Params — 400

{
  "error": "...",
  "code": "user/invalid-params"
}

Overview

Auth Endpoints

OAuth Endpoints

User Endpoints

User Follow Operations

User Connection Operations

Follow Endpoints

Connection Endpoints

Entity Endpoints

Comment Endpoints

Chat — Conversations

Chat — Members

Chat — Messages

Collection Endpoints

App Notification Endpoints

Push Notification Endpoints

Report Endpoints

Search Endpoints

Space Endpoints

Space — Membership

Space — Rules

Space — Moderation

Space — Chat

Event Endpoints

Storage Endpoints

Utils

Crypto

Authentication

Path Parameters

Body Parameters

Response

Error Responses

See Also

​Authentication

​Path Parameters

​Body Parameters

​Response

​Error Responses

​See Also

Authentication

Path Parameters

Body Parameters

Response

Error Responses

See Also