Skip to main content
PUT
/
auth
/
user
/
{id}
Update a user
curl --request PUT \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/user/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "country_code": "<string>",
  "profile_image_url": "<string>",
  "login_methods": [
    "email"
  ],
  "notification_preferences": {
    "transactional": {
      "email": true,
      "sms": true,
      "whatsapp": true
    },
    "promotional": {
      "email": true,
      "sms": true,
      "whatsapp": true
    },
    "newsletter": {
      "email": true,
      "sms": true,
      "whatsapp": true
    }
  }
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "is_email_verified": true,
      "phone": "<string>",
      "country_code": "<string>",
      "is_phone_verified": true,
      "profile_image_url": "<string>",
      "is_anonymous": true,
      "is_logged_in": true,
      "login_methods": [
        "email"
      ],
      "notification_preferences": {
        "transactional": {
          "email": true,
          "sms": true,
          "whatsapp": true
        },
        "promotional": {
          "email": true,
          "sms": true,
          "whatsapp": true
        },
        "newsletter": {
          "email": true,
          "sms": true,
          "whatsapp": true
        }
      },
      "created_at": "<string>",
      "modified_at": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Access token

Path Parameters

​
id
string
required

user ID

Body

application/json
​
first_name
string | null
required

User’s first name.

​
last_name
string | null
required

User’s last name.

​
email
string<email> | null
required

User’s email I’d.

​
phone
string | null
required

10 digit phone number without country code.

​
country_code
string | null
required

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. Use this key along with phone. Not necessary for email.

​
profile_image_url
string | null
required

URL to the user's profile image.

​
login_methods
enum<string>[]
required
​
notification_preferences
object
required

User's notification preferences are categorized by transactional, promotional, and newsletter types.

Response

OK

​
message
string
required

A descriptive message confirming the success or failure of the Registration process.

​
success
boolean
required

Indicates whether the request was successful or failure (true for success, false for failure).

​
content
object
required

An object containing the response content.

⌘I