Update a Customer

Authorization

AuthorizationBearer <token>

Merchant JWT bearer token

In: header

Scope: customers.update

Path Parameters

customerId*string

A unique identifier for a customer object.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName?Name

The customer's first name

lastName?OptionalName

The customer's last name

email?UpdateableEmailAddress

The customer's email address

phoneNumber?OptionalPhoneNumber

The customer's phone number

avatarUrl?Url

The url to the customer's avatar image

address?

The customer's address

language?Language

The customer's language preference

referenceId?ReferenceId

A unique identifier set by a developer to help reconcile this object with any internal systems

metaData?

A Key-value object to hold additional data

Response Body

`application/json`

curl -X PATCH "https://example.com/customers/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "merchantId": "string",
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "test@example.com",
  "phoneNumber": "string",
  "avatarUrl": "https://www.randomurl.com",
  "address": {
    "addressLines": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string"
    },
    "name": "string",
    "city": "string",
    "country": "AF",
    "postalCode": "string",
    "organization": "string",
    "sublocality": "string"
  },
  "language": "aa",
  "referenceId": "string",
  "metaData": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z"
}

{
  "http_status_code": 100,
  "moreInfo": "https://www.randomurl.com",
  "name": "string",
  "detail": "string",
  "instance": "/pets/dogs/123",
  "property1": null,
  "property2": null
}

Update a Customer

Authorization

Path Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`