API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Accounts
- POSTAdd Account
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETRetrieve Current Account
- GETGet Transactions
- POSTAdd Transaction
- DELRemove Transaction
- POSTRecompute Customer Lifetime Value
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Segments
- GETGet Account Audit Log
- GETGet Customer Purchase Order Account
- PUTUpdate Customer Purchase Order Account
- POSTCreate Customer Purchase Order Account
- GETGet Customer Purchase Order Transactions
- POSTCreate Purchase Order Transaction
- POSTGet Customers Purchase Order Accounts
- POSTGet Login State By UserName
- POSTGet Login State By Email Address
- GETGet Login State
- POSTChange Password
- POSTChange Passwords
- POSTReset Password
- POSTUpdate Forgotten Password
- POSTAdd Login To Existing Customer
- POSTAdd Account And Login
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTAdd Accounts
- GET
A valid request URL is required to generate request examples{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}Update Account Contact
Updates a CustomerContact for a specified customer account, for example to update addresses or change which CustomerContact is the primary CustomerContact for billing.
A valid request URL is required to generate request examples{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the customer account whose CustomerContact information you want to update.
Query Parameters
If provided, the primary markings on the contact will be stored as the user's preferred primary override
limits which fields are returned in the response body
Body
CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes