Update a user's profile

PUT/users/{userId}Update a user's profile

Updates whitelisted profile fields. The endpoint intentionally does not accept identity-bound fields — email, clerkUserID, and the canonical id are owned by Clerk and cannot be changed through the API. Unknown fields in the body are silently ignored.

Parameters

userIdstring · uuidpathrequired

User UUID.

Request body

required

application/json

objectUpdateUserRequest

PATCH-style update. Only the listed whitelisted fields are applied; any other field (including `email`, `clerkUserId`, `id`, etc.) is silently ignored.

firstNamestring

imageUrlstring · uri

lastNamestring

Example request

{
  "firstName": "string",
  "imageUrl": "https://example.com",
  "lastName": "string"
}

Responses

Headers

X-RateLimit-Limit

The request cap for the tighter of the per-organization / per-endpoint windows that applied to this request.

X-RateLimit-Remaining

Requests remaining in the current window.

X-RateLimit-Reset

Unix timestamp (seconds) when the current window resets.

value

allOf · 2 options

Option 1objectEnvelope

datavaluerequired

The response payload — shape depends on the endpoint.

metaobjectrequired

Pagination metadata — populated on list endpoints, empty on single-resource endpoints.

Show child attributes

cursornull | string

Opaque cursor to pass to the next request.

hasMoreboolean | null

True when further pages of results are available.

Option 2object

dataobject

Organization user. Identity-bound fields (`email`) are readable but not writable via this API — identity is owned upstream. The spec mentions `phone`, but the current user model does not carry one — tracked as a follow-up.

Show child attributes

createdAtstring · date-timerequired

emailstring · emailrequired

Read-only on this API surface.

firstNamestringrequired

idstring · uuidrequired

imageUrlnull | string · uri

lastNamestringrequired

updatedAtstring · date-timerequired

Example response

{
  "data": {
    "createdAt": "2026-06-09T00:00:00Z",
    "email": "alice@acme.com",
    "firstName": "Alice",
    "id": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://example.com",
    "lastName": "Morgan",
    "updatedAt": "2026-06-09T00:00:00Z"
  },
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

Headers

Retry-After

Seconds the client should wait before retrying.

objectErrorEnvelope

errorobjectrequired

Show child attributes

codestringrequired

Machine-readable error category.

one of "unauthorized", "forbidden", "not_found", "invalid_argument", "conflict", "rate_limited", "internal_error", "not_implemented"

detailsobject

Optional per-code context (field names, retry windows, …).

messagestringrequired

Human-readable description — intended for operator logs, not end-user display.

Example response

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Examples

userIdrequiredpath parameter

curl -X PUT 'https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"firstName":"string","imageUrl":"https://example.com","lastName":"string"}'

const response = await fetch('https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"firstName":"string","imageUrl":"https://example.com","lastName":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"firstName\":\"string\",\"imageUrl\":\"https://example.com\",\"lastName\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"firstName":"string","imageUrl":"https://example.com","lastName":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"firstName":"string","imageUrl":"https://example.com","lastName":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"firstName\":\"string\",\"imageUrl\":\"https://example.com\",\"lastName\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"firstName\":\"string\",\"imageUrl\":\"https://example.com\",\"lastName\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"firstName\":\"string\",\"imageUrl\":\"https://example.com\",\"lastName\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://api.salfio.com/v1/users/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"firstName\":\"string\",\"imageUrl\":\"https://example.com\",\"lastName\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "createdAt": "2026-06-09T00:00:00Z",
    "email": "alice@acme.com",
    "firstName": "Alice",
    "id": "00000000-0000-0000-0000-000000000000",
    "imageUrl": "https://example.com",
    "lastName": "Morgan",
    "updatedAt": "2026-06-09T00:00:00Z"
  },
  "meta": {
    "cursor": "string",
    "hasMore": true
  }
}

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "client not found"
  }
}

{
  "error": {
    "code": "rate_limited",
    "details": {
      "retry_after_seconds": 30
    },
    "message": "Rate limit exceeded"
  }
}

Search documentation

Update a user's profile

Parameters

Request body

Responses

Headers

Headers

Documentation menu