Skip to main content
PATCH
/
v1
/
me
Update current user profile
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({display_name: 'Alice Chen', given_name: 'Alice', family_name: 'Chen'})
};

fetch('https://api.factify.com/v1/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "usr_01h2xcejqtf2nbrexx3vqjhp41",
  "email": "alice@factify.com",
  "display_name": "Alice Chen",
  "given_name": "Alice",
  "family_name": "Chen"
}

Documentation Index

Fetch the complete documentation index at: https://developers.factify.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Body

application/json

Request body for PATCH /v1/me. Optional nullable fields use RFC 7396 merge-patch semantics: omit to leave unchanged, send null to clear, send a value to set. display_name is required on every request and cannot be cleared.

display_name
string
required

New display name. Required; empty string is rejected.

Required string length: 1 - 255
Example:

"Alice Chen"

given_name
string | null

New given (first) name. Send null to clear. Empty string is rejected — use null.

Required string length: 1 - 128
Example:

"Alice"

family_name
string | null

New family (last) name. Send null to clear. Empty string is rejected — use null.

Required string length: 1 - 128
Example:

"Chen"

Response

OK

Profile of the authenticated user. Returned by GET /v1/me and PATCH /v1/me.

id
string
required

TypedID of the user.

Example:

"usr_01h2xcejqtf2nbrexx3vqjhp41"

email
string<email>
required

User's email address.

Example:

"alice@factify.com"

display_name
string
required

Display name shown in the UI. Always present.

Example:

"Alice Chen"

given_name
string | null

Given (first) name. Null when unknown.

Example:

"Alice"

family_name
string | null

Family (last) name. Null when unknown.

Example:

"Chen"