Auth API reference

Auth API · Consumer-Me

patch/{app_slug}/v1/meAuth

Update the signed-in EndUser profile

Editable fields: `display_name` and `username`. The username is unique per app (case-insensitive, same rule as signup); sending the current username is a no-op. Usernames cannot be cleared.

Path parameters

app_slug*string

Slug of the app.

Request body

display_namestring

New display name. Pass an empty string to clear it; omit to leave unchanged.

Example: "Ada Lovelace"

usernamestring

New username. Unique per app, case-insensitive. 3-32 chars: letters, numbers, dot, underscore, hyphen. Omit to leave unchanged — cannot be cleared. 409 `USERNAME_TAKEN` when another account in the app holds it.

Example: "jane_doe"

Response · 200 Updated account row.

id*string

EndUser account id (UUID).

app_id*string

Owning app UUID.

seq_id*string

Monotonic per-table sequence id (Postgres int8, serialized as a string).

Example: "42"

username*string

Username inside the app.

Example: "ada"

display_name*string

Human-readable name of the account.

Example: "Ada Lovelace"

status*string

Account status: `active`, `suspended` or `deactivated`.

Example: "active"

locale*string

Preferred locale (BCP 47 tag, e.g. `pt-PT`), or `null`.

Example: "en-GB"

time_zone*string

Preferred time zone (IANA name, e.g. `Europe/Lisbon`), or `null`.

Example: "Europe/Lisbon"

metadata*object

Free-form metadata blob stored on the account row.

created_at*string · date-time

When the account was created (ISO 8601).

updated_at*string · date-time

When the account was last changed (ISO 8601).

Example

Request

PATCH https://api.auth.productcraft.co/{app_slug}/v1/me
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "display_name": "Ada Lovelace",
  "username": "jane_doe"
}

Response

{
  "id": "string",
  "app_id": "string",
  "seq_id": "42",
  "username": "ada",
  "display_name": "Ada Lovelace",
  "status": "active",
  "locale": "en-GB",
  "time_zone": "Europe/Lisbon",
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}