Skip to main content
PATCH
/
api
/
v1
/
users
/
{user_id}
/
curl --request PATCH \
  --url https://hpay-api.host-sl.com/api/v1/users/9a8b7c6d-.../ \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "New Name" }'
{
  "id": "9a8b7c6d-...",
  "app_user_id": "user_123",
  "name": "New Name",
  "email": "alice@example.com",
  "username": "alice",
  "phone_number": "+23279000000",
  "is_active": true,
  "created_at": "2026-01-16T10:30:00Z",
  "stripe_connect_account_id": null,
  "stripe_connect_verified": false
}
Unlike update user (a full PUT that requires the complete body), this changes only the fields present in the request. app_user_id is immutable and not accepted.

Path Parameters

user_id
string
required
The user to update.

Request Body

name
string
The user’s display name.
email
string
The user’s email address.
username
string
The user’s username.
phone_number
string
The user’s phone number.
is_active
boolean
Activate or deactivate the user.

Response

The full updated user, same shape as get user.
{
  "id": "9a8b7c6d-...",
  "app_user_id": "user_123",
  "name": "New Name",
  "email": "alice@example.com",
  "username": "alice",
  "phone_number": "+23279000000",
  "is_active": true,
  "created_at": "2026-01-16T10:30:00Z",
  "stripe_connect_account_id": null,
  "stripe_connect_verified": false
}
curl --request PATCH \
  --url https://hpay-api.host-sl.com/api/v1/users/9a8b7c6d-.../ \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "New Name" }'