Users Partial Update

Authorization

oauth2 users:write

AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: users:write

Path Parameters

id*integer

A unique integer value identifying this User.

Header Parameters

X-29next-API-Version*"2024-04-01"

Default"2024-04-01"

Value in

"2024-04-01"

Request Body

accepts_marketing?Subscribe to Marketing Emails

email?string

Formatemail

first_name?string

Lengthlength <= 255

ip?string|null

is_blocked?boolean

Defaultfalse

language?|

required : E164

en - English
fr - Français
th - ภาษาไทย
de - Deutsch
sv - Svenska
no - Norsk
it - Italiano
es - Español
nl - Nederlands
pt - Português
da - Dansk
fi - Suomi

Value in

"en"
"fr"
"th"
"de"
"sv"
"no"
"it"
"es"
"nl"
"pt"
"da"
"fi"
""
null

last_name?string

Lengthlength <= 255

metadata?unknown|null

phone_number?string|null

tags?array<string|null>

user_agent?string|null

Response Body

`application/json`

curl -X PATCH "https://example.com/users/0/" \  -H "X-29next-API-Version: 2024-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{  "accepts_marketing": true,  "addresses": [    {      "country": "string",      "first_name": "string",      "id": 0,      "is_default_for_billing": true,      "is_default_for_shipping": true,      "last_name": "string",      "line1": "string",      "line2": "string",      "line3": "string",      "line4": "string",      "notes": "string",      "phone_number": "string",      "postcode": "string",      "state": "string"    }  ],  "date_joined": "2019-08-24T14:15:22Z",  "email": "user@example.com",  "first_name": "string",  "id": 0,  "ip": "string",  "is_blocked": false,  "language": "en",  "last_name": "string",  "metadata": null,  "orders_count": 0,  "phone_number": "string",  "subscriptions_count": 0,  "tags": [    "string"  ],  "total_spent": "0.00",  "user_agent": "string",  "user_type": "customer"}