Skip to main content
PATCH
/
user
Update current user profile
curl --request PATCH \
  --url https://store.salesive.com/api/v1/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "name": "Jane Smith",
  "phone": "08099887766",
  "avatar": "<string>"
}
'
{}

​
Request

PATCH /user
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}
Content-Type: application/json

{
    "name": "Jane Smith",
    "phone": "08099887766"
}

​
Body parameters

FieldTypeDescription
namestringOptional. Display name (1–120 characters).
phonestringOptional. 6–20 characters.
avatarstringOptional. Absolute URL to an avatar image.
At least one field must be supplied. An empty body returns 400.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "User profile updated",
    "data": {
        "user": {
            "_id": "651f8a1b2c3d4e5f60718293",
            "name": "Jane Smith",
            "email": "jane@example.com",
            "phone": "08099887766",
            "role": "user",
            "avatar": "https://cdn.salesive.com/avatars/jane.webp",
            "updatedAt": "2026-06-18T03:21:00.000Z"
        }
    }
}

​
Error response

{
    "status": 400,
    "success": false,
    "message": "\"value\" must have at least 1 key",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
​
name
string
Example:

"Jane Smith"

​
phone
string
Example:

"08099887766"

​
avatar
string<uri>

Response

Profile updated.

The response is of type object.