Update Stored Customer Contact Data.

put https://stage.check21.com/c2/api/customer/{id}

The PUT Customer Endpoint is used to update stored Customer contact data or to change the status of the customer to Inactive. Please note: By changing the status of the Customer, any existing Customer Recurring records will become void.

Path Params

number

required

The Customer ID is provided within the JSON response when utilizing the POST /Customer Endpoint.

Body Params

int32

required

accountId

int32

required

companyName

string

required

length between 3 and 100

companyName is required if firstName and lasName fields are empty. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed.

firstName

string

required

length between 3 and 50

firstName is not required if companyName field is not null. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed. No numbers are allowed.

lastName

string

required

length between 3 and 50

lastName is not required if companyName field is not null. Only commas, hyphens, periods, ampersands, apostrophe symbols are allowed. No numbers are allowed.

address1

string

length ≤ 100

address2

string

length ≤ 100

city

string

length between 3 and 100

Symbols and numbers are not allowed.

state

string

required

length between 2 and 20

State data is limited to US States (2 Letter Abbreviation)if Country selected is US. All other countries allow free-form text to be applied within the field. Symbols and numbers are not allowed.

zip

string

length between 5 and 10

If Country selected is US, zip code requires 5 numeric characters. Zip field will be used in lieu of postal code should other countries be selected.

country

string

length between 2 and 2

If a value for the field is not provided, US will be selected by default. If you are unsure of the country code abbreviations, please contact your account manager for a full glossary of data.

phone

string

length between 10 and 13

Parentheses and hyphens are the only symbols allowed. No alpha characters allowed.

string

length between 6 and 50

externalId

string

length between 1 and 50

This field should be used only if attempting to correlate between your internal customer ID and the Check21.com system.

status

string

required

When updating a customer within the Check21.com gateway, the customer status can be changed to Active or Inactive.

Headers

string

required

application/json should be set.

X-Auth-ApiKeyContent

string

required

Can be found in the administrative user profile within the Check21.com Gateway

X-Auth-ApiKeyAccess

string

required

Can be found in the administrative user profile within the Check21.com Gateway

Responses

200Successful response.

400Improper selection of state or country. Can also be an indication that the API Authentication values are incorrect. See message for more details.

500Customer ID in body and/or path submitted cannot be found. Please ensure both IDs are the same.