Update a customer

How to update an existing customer via API

To update an existing customer, send a PATCH request to the /api/customers/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/customers/:id

Arguments

Body Parameter	Type	Required
type	string	Required
id	string	Required
attributes.email	string	Optional
attributes.password	string	Optional
attributes.shopper_reference	string	Optional
attributes.profile_id	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.customer_group	object	Optional
relationships.tags	array	Optional

Example

Request

The following request updates the customer identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/customers/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "customers",
    "id": "xYZkjABcde",
    "attributes": {
      "password": "secret"
    },
    "relationships": {
      "customer_group": {
        "data": {
          "type": "customer_groups",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the updated resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "customers",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde"
    },
    "attributes": {
      "email": "[e-mail]",
      "status": "prospect",
      "has_password": false,
      "total_orders_count": 6,
      "shopper_reference": "xxx-yyy-zzz",
      "profile_id": "xxx-yyy-zzz",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer_group": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_group",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_group"
        }
      },
      "customer_addresses": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_addresses",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_addresses"
        }
      },
      "customer_payment_sources": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_payment_sources",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_payment_sources"
        }
      },
      "customer_subscriptions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/customer_subscriptions",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/customer_subscriptions"
        }
      },
      "orders": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/orders",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/orders"
        }
      },
      "order_subscriptions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/order_subscriptions",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/order_subscriptions"
        }
      },
      "returns": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/returns",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/returns"
        }
      },
      "sku_lists": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/sku_lists",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/sku_lists"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/attachments"
        }
      },
      "events": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/events",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/events"
        }
      },
      "tags": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/relationships/tags",
          "related": "https://yourdomain.commercelayer.io/api/customers/xYZkjABcde/tags"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}