Skip to main content
PATCH
/
api
/
v2
/
platform
/
users
/
{id}
Update a User
curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "password": "<string>",
    "password_confirmation": "<string>",
    "selected_locale": "<string>",
    "ship_address_id": "<string>",
    "bill_address_id": "<string>",
    "public_metadata": {},
    "private_metadata": {}
  }
}
'
{
  "data": {
    "id": "144",
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "first_name": "Astrid",
      "last_name": "Kohler",
      "selected_locale": "fr",
      "created_at": "2022-11-08T19:35:55.180Z",
      "updated_at": "2022-11-08T19:35:55.414Z",
      "public_metadata": {},
      "private_metadata": {},
      "average_order_value": [],
      "lifetime_value": [],
      "store_credits": []
    },
    "relationships": {
      "bill_address": {
        "data": null
      },
      "ship_address": {
        "data": null
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
​
user
object
required

Response

Record updated

​
data
object
required