Update Customer

PATCH 
/customers/:customer_id

Updates an existing customer for the merchant. Only certain customers' fields will be editable when the customer is verified

Request

application/json

Body

required

anyOf

Unverified Customer

first_name stringnullable

Possible values: <= 255 characters

First name of the customer

last_name stringnullable

Possible values: <= 255 characters

Last name/s of the customer

dob

object

Birthdate for an individual

day integerrequired

month integerrequired

year integerrequired

ssn SSN (string)nullable

Possible values: <= 10 characters

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

shipping

object

nullable

name stringrequired

Possible values: <= 255 characters

Name of the shipping contact person

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

required

Address of the shipping destination

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

Verified Customer

email emailnullable

Possible values: <= 255 characters

Email Address

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

nullable

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

shipping

object

nullable

name stringrequired

Possible values: <= 255 characters

Name of the shipping contact person

phone_number PhoneNumber (string)nullable

Possible values: non-empty and <= 20 characters

Phone Number

address

object

required

Address of the shipping destination

country CountryISO (string)nullable

Possible values: >= 2 characters and <= 2 characters

Two-letter code ISO 3166-1 country code

line1 stringnullable

Possible values: <= 255 characters

line2 stringnullable

Possible values: <= 255 characters

zip stringnullable

Possible values: <= 255 characters

city stringnullable

Possible values: <= 255 characters

state stringnullable

Possible values: <= 255 characters

Responses

200

Customer updated

application/json

Schema

Schema

status string

Possible values: [success]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Customer not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

409

Customer update failed due to a conflict in the provided entity

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

422

Customer update failed due to validation failure

application/json

Schema

Schema

status string

Possible values: [error]

data object
code integer

Possible values: [422]

message string

Example (from schema)

{
  "status": "error",
  "data": {
    "dob": {
      "day": "Value expected to be 'integer', 'string' given."
    }
  },
  "code": 422,
  "message": "cannot process the provided entity"
}

500

Server error

Loading...