PATCH
/
v1
/
users
/
{id}
Update user
curl --request PATCH \
  --url https://api.oneofnone.io/v1/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "phone": "<string>",
  "email": "jsmith@example.com",
  "metadata": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "metadata": {},
  "avatar": {
    "alt": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "file_type": "<string>",
    "id": 123,
    "poster_url": "<string>",
    "size": 123,
    "tags": [
      "<string>"
    ],
    "thumbnail_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "url": "<string>"
  },
  "app_id": 123,
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_login_at": "2023-11-07T05:31:56Z",
  "login_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Path Parameters

id
string<uuid>
required

The unique identifier of the user to update.

Body

application/json
phone
string

The user's phone number.

email
string<email>

The user's email address.

metadata
object

Additional user metadata and custom fields.

Response

Successfully updated user.

A user account within the application system, containing profile information and activity tracking.

id
string<uuid>

The unique identifier for the user.

email
string<email> | null

The user's email address.

phone
string | null

The user's phone number.

metadata
object | null

Additional user metadata and custom fields collected during registration or profile updates.

avatar
object

The user's profile avatar image. Note that only the url field is populated in user responses.

app_id
integer | null

The unique identifier of the app the user is associated with.

team_id
string<uuid> | null

The unique identifier of the team the user belongs to.

last_login_at
string<date-time> | null

The timestamp of the user's last login.

login_count
integer | null

The total number of times the user has logged in.

created_at
string<date-time>

The timestamp when the user account was created.

updated_at
string<date-time> | null

The timestamp when the user account was last updated.