Skip to content

Latest commit

 

History

History
141 lines (117 loc) · 3.24 KB

update-a-customer.md

File metadata and controls

141 lines (117 loc) · 3.24 KB

Update a Customer

{% api-method method="put" host="https://api.moltin.com" path="/v2/customers/:customerId" %} {% api-method-summary %} Update by ID {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="customerId" type="string" required=true %} The ID for the customer requested {% endapi-method-parameter %} {% endapi-method-path-parameters %}

{% api-method-headers %} {% api-method-parameter name="X-Moltin-Customer-Token" type="string" required=false %} A customer token used to access customer implicitly. {% endapi-method-parameter %}

{% api-method-parameter name="Authorization" type="string" required=true %} The Bearer token to grant access to the API. If there is no customer token the grant type must be client_credentials. {% endapi-method-parameter %} {% endapi-method-headers %}

{% api-method-body-parameters %} {% api-method-parameter name="type" type="string" required=true %} The type of object being returned. {% endapi-method-parameter %}

{% api-method-parameter name="name" type="string" required=false %} The full name of the customer. {% endapi-method-parameter %}

{% api-method-parameter name="email" type="string" required=false %} The customer email {% endapi-method-parameter %}

{% api-method-parameter name="password" type="string" required=false %} The customer password {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "data": {
        "type": "customer",
        "id": "b57022cf-c80e-4b85-9fd1-5af3156d8adf",
        "name": "George example",
        "email": "[email protected]",
        "password": true
    }
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% tabs %} {% tab title="cURL" %}

curl -X PUT https://api.moltin.com/v2/customers/:customerId \
    -H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{
     "data": {
       "type": "customer",
       "email": "[email protected]"
     }
}'

{% endtab %}

{% tab title="JavaScript SDK" %}

const MoltinGateway = require('@moltin/sdk').gateway

const Moltin = MoltinGateway({
  client_id: 'X'
})

var customerId = 'XXXX'

var customer = {
    email: "[email protected]"
}

Moltin.Customers.Update(customerId, customer).then((response) => {
  // Do something
});

{% endtab %} {% endtabs %}

With customer token

{% tabs %} {% tab title="cURL" %}

curl -X GET https://api.moltin.com/v2/customers/:id \
     -H "X-Moltin-Customer-Token: XXXX"
     -H "Authorization: Bearer XXXX"
     -d $'{
     "data": {
       "type": "customer",
       "email": "[email protected]"
     }
}'

{% endtab %} {% endtabs %}

Without customer token

{% tabs %} {% tab title="cURL" %}

curl -X GET https://api.moltin.com/v2/customers/:id \
     -H "Authorization: Bearer XXXX"
     -d $'{
     "data": {
       "type": "customer",
       "email": "[email protected]"
     }
}'

{% endtab %} {% endtabs %}