Home > API > Common > Update customer

Update customer

Updates customer information

PATH:

/api/v3/customers/{customerNumber}/updateCustomer

PATH PARAMETERS:

customerNumber
required

string

REQUEST BODY SCHEMA:

distributionType

string

Enum: Paper Email Sms

Specifies how information (invoices, notices, etc.) will be distributed to customer.

email

string <= 255 characters

Email. Required if distributionType is 'Email'.

mobilePhone

string <= 20 characters

Mobile phone. International format including country prefix. Required if distributionType is 'Sms'.

RESPONSES:

200 OK

RESPONSE SCHEMA:

  • {
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

patch

/api/v3/customers/{customerNumber}/updateCustomer

Request samples

  • {
    • "distributionType": "string",
    • "email": "string",
    • "mobilePhone": "string"
  • }

Response samples

200400
  • {
      }
    • [
        ...
        • {
          • "type": "string",
          • "code": "string",
          • "message": "string",
          • "customerFacingMessage": "string",
          • "actionCode": "string",
          • "fieldReference": "string"
          }
      ]