v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Update customer

put/{companyDomain}/customers/{customerUniqueId}

Path parameters

companyDomainstring required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

customerUniqueIdstring required

The unique identifier of the customer in the Billsby platform

Request body

firstNamestring required

The customers first name

lastNamestring required

The customers last name

phoneNumberDialCountrystring

The customers phone number dial country (i.e. "UK")

phoneNumberDialCodestring

The customer phone number dial code

emailstring required

The email address we have on file for the customer

phoneNumberstring

The phone number we have on file for the customer. Remove "0" from the start.

Response

200

customerIdstring

firstNamestring

lastNamestring

emailstring

additionalEmailstring

phoneNumberDialCountrystring

phoneNumberDialCodestring

phoneNumberstring

isMarketingConsentGivenboolean

createdOnstring

uniqueIdstring

Example response

{
  "customerId": "6DK82SKD",
  "firstName": "mary",
  "lastName": "quinn",
  "billingAddress": {
    "addressLine1": "32 woodford road",
    "addressLine2": "saltdean",
    "state": "brighton",
    "city": "brighton",
    "country": "USA",
    "postCode": "BN3 6HE"
  },
  "email": "mary.quinn@mistmail.com",
  "additionalEmail": "marymay@mistimail.com",
  "phoneNumberDialCountry": "USA",
  "phoneNumberDialCode": "+1",
  "phoneNumber": "07283928192",
  "isMarketingConsentGiven": true,
  "createdOn": "2019-09-03T13:31:55.138Z",
  "uniqueId": "AHD12QR4"
}