Attention!

Looking for the most up-to-date Sales Tax Filing or CertManager documentation? Go to our new documentation platform, Sovos Docs. For Global Tax Determination, connector and CertManager API docs, stay here.

Update an existing customer

Request information

  • HTTP method: PUT
  • Content-type header: application/json
  • URL
    • CertManager UAT:
      https://certmanager-uat.sovos.com/api/pre-auth/v1/configuration/customers
    • CertManager Production:
      https://certmanager.sovos.com/api/pre-auth/v1/configuration/customers

JSON request fields

Because the HTTP PUT request replaces the current customer information with the information passed in the request, you must include all fields relevant to that customer in the request body — even the fields that are not being updated. If you do not pass a field, the API replaces the current value with a null value. For example, if a customer has a phone number set but you do not include the phoneNumber field in your request body, the phone number will be deleted.

Field

Data type

Required or optional

Description
customerName String Required

The name of the customer you want to update

OR

If oldCustomerName is passed, then customerName is the updated name of the customer
customerNumber String Required

The number of the customer you want to update

OR

If oldCustomerNumber is passed, then customerNumber is the updated number of the customer
contactName String Optional Customer contact's name
email String Optional Customer contact's email
phoneNumber String Optional Customer contact's phone number
faxNumber String Optional Customer contact's fax number
notes String Optional Notes about the customer
emailCampaignPreference String Optional

If O, the customer the email is addressed to will receive the email

(For child customers) If P, the parent customer will receive that child customer's email

(For parent customers) If F, that parent customer will receive emails for all its children
customerAddresses List Optional List of customer's addresses/locations
oldCustomerName String Required if updating customer name Current customer name
oldCustomerNumber String Required if updating customer number Current customer number

customerAddresses fields

Field

Data type

Required or optional

Description
address1 String Optional Address line 1
address2 String Optional Address line 2
city String Optional City
zipCode String Optional ZIP code
zipPlus4 String Optional Four-digit ZIP code extension
stateCode String Optional Two-letter state or province code
stateName String Optional State or province name
countryCode String Optional Two-letter country code
country String Optional Country name
addressName String Optional Address name
phoneNumber String Optional Address phone number
faxNumber String Optional Address fax number
notes String Optional Notes about the address

Example request

{
  "customerName": "NewCustomerName",
  "customerNumber": "8938137",
  "contactName": "Contact Name",
  "email": "contact.email@test.com",
  "phoneNumber": "1234567890",
  "faxNumber": "0987654321",
  "notes": "Notes about contact",
  "emailCampaignPreference": "O",

  "addresses": [
    {
      "address1": "1 Main Street",
      "address2": "2 Main Street",
      "city": "Boston",
      "zipCode": "11111",
      "addressName": "Location name",
      "phoneNumber": "1234567890",
      "faxNumber": "09876543231",
      "notes": "location notes"
    }
  ],
  "oldCustomerName": "OldCustomerName",
  "oldCustomerNumber": "oldNumber"
}

Example response

{
    "status": 200,
    "message": "CorrelationId: f9d1c1cb-86c9-41f9-b0dd-ca653874737f - Updated a customer",
    "data": {
        "customerId": "3b6a4a83-e917-42df-b1b3-9d501f73b4ec",
        "dateOfCreation": 1732632983484,
        "customerName": "NewCustomerNameExample",
        "customerNumber": "8938137",
        "contactName": "Contact Name",
        "savedInGtd": true,
        "lastModified": 1732633398179,
        "lastModifiedBy": "modifier@example.com",
        "phoneNumber": "1234567890",
        "faxNumber": "0987654321",
        "notes": "Notes about contact",
        "gtdErrorMessage": null,
        "emailCampaignPreference": "O",
        "hasChildren": false,
        "numberOfChildren": null,
        "customerEmails": [
            {
                "email": "contact.email@test.com"
            }
        ],
        "customerAddresses": [
            {
                "addressId": 1616930,
                "address1": "1 Main Street",
                "address2": "2 Main Street",
                "city": "Boston",
                "zipCode": "11111",
                "zipPlus4": null,
                "state": null,
                "jurisdictionId": 273,
                "country": null,
                "addressName": "Location name",
                "phoneNumber": "1234567890",
                "faxNumber": "09876543231",
                "notes": "location notes",
                "exemptionExists": false
            }
        ],
        "parentId": null,
        "parentCustomer": null
    },
    "success": true
}