Skip to Main Content

Update Customer

Updates customer information

Path

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

Request Parameters

customerNumber

required

string

Request Body

application/json

distributionType

string

Enum:

Paper
Email
Sms

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

email

string

Max length: 255

Email. Required if distributionType is 'Email'.

mobilePhone

string

Max length: 20

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

Responses

200 OK
type

string

Enum:
BusinessError
TechnicalError
NotificationMessage
code

string
Max length: 100

Confirmation or error code

message

string
Max length: 4096

Message content

customerFacingMessage

string
Max length: 4096

Message to display to customer
actionCode

string

Enum:
Unavailable
AskConsumerToConfirm
AskConsumerToReEnterData
OfferSecurePaymentMethods
RequiresSsn
AskConsumerToIdentify
ManualReview

Action codes
fieldReference

string
Max length: 100

Reference to field that caused an error
401 Authorization has been denied for this request.
413 Request body too large.
429 Too many requests.
500 Internal server error.

Successful Request

Request Example

    
        {
 "email": "astrid.svensson@example.com",
 "mobilePhone": "76543210",
 "distributionType": "Email"
}

Response Example

{}