Replace customer

put

https://ecm.cert.ceretax.net/customers/{id}

This endpoint can be used to fully replace a previously created customer.

All required fields must be supplied, exactly as they are for a create. Optional fields that are omitted are cleared. If customerId is included in the body, it must match the id path parameter.

Nested records are matched by their own IDs. An entry carrying contactId, addressId, customerDbaId, or ID updates that existing record, and an entry without one is inserted as a new record. Any nested ID that does not already belong to the customer is rejected with a 422.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

≥ 1

The customer ID of the customer being replaced. Must be a positive integer.

Body Params

The payload used to replace or partially update a customer. For a replace ( PUT ), the same fields are required as for a create. For a partial update ( PATCH ), every field is optional and only the fields that are present are validated and applied.

Nested records are matched by their own IDs. An entry carrying contactId, addressId, customerDbaId, or ID updates that existing record, and an entry without one is inserted as a new record.

customerId

int64

The ID of the customer being updated. This field is optional, but when it is present it must match the id path parameter.

customerName

string

length ≤ 255

The name of the customer.

customerAccount

string

length ≤ 255

The customer reference code from your billing, accounting, and/or ecommerce system for this customer.

taxpayerId

string

length ≤ 9

The customer's taxpayer identification number. This field may be omitted on a partial update, but when your account is configured to require a taxpayer ID it cannot be explicitly set to an empty string.

systemOriginId

string

length ≤ 255

The identifier of this customer in your source system.

userId

integer

≥ 0

The ID of the user updating this customer.

contacts

array of objects

A list of contacts associated with this customer.

contacts

addresses

array of objects

A list of addresses associated with this customer.

addresses

dbas

array of objects

A list of "doing business as" names associated with this customer.

dbas

alternateIds

array of objects

A list of alternate identifiers associated with this customer.

alternateIds

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

422The customer could not be updated.

500An internal error occurred.