Skip to main content

Customers

Status: Trusted Tester

A customer is a person a business location has had a prior business relationship with and permission to contact.

Customer records are displayed within Business App and are available to marketplace products. If you are looking for contacts within Sales and Success Center, see Sales Contact.

typestring

Possible values: [customers]

Default value: customers
Example: customers
idstring

Possible values: non-empty

Example: AG-123:CUSTOMER-123
attributes object
givenNamestring

Given name(s) or first name(s) of the customer. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

Possible values: non-empty

Example: William
familyNamestring

Surname(s) or last name(s) of the customer. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

Possible values: non-empty

Example: Smith
address object
streetAddressstring

Possible values: non-empty

Example: 123 Fake St.
citystring

The city, town or locality component of an address.

Possible values: non-empty

Example: Kalamazoo
regionCodestring

The code for the top level subdivision within the country (state/province). For more info see the Addresses guide

Examples: CA-SK, US-FL, AG-08, AU-NSW

Possible values: non-empty

Example: US-MI
countryCodestring

The two letter country code. For more info see the Addresses guide

Examples: CA, US, AU

Possible values: >= 2 characters and <= 2 characters

Example: US
phoneNumbersstring[]

A comma-separated list of phone numbers for a customer in E.164 format ex. +13065551234. At least one unique phone number or email is required.

emailAddressesemail[]

A list of email addresses for a customer. At least one unique phone number or email is required.

tagsstring[]

A list of business identifiers used to categorize customer resources.

permissionToContactboolean

Whether the customer has given permission to be contacted for marketing purposes.

Default value: false
createdAtdate-time

The time at which the customer was initially created in the platform.

updatedAtdate-time

The time at which the customer was last updated.

relationships object
businessLocation object
data object
idstringrequired

The ID of the business location the customer belongs to.

Possible values: non-empty

typestring

Possible values: [businessLocation]

Default value: businessLocation
Customers
{
  "type": "customers",
  "id": "AG-123:CUSTOMER-123",
  "attributes": {
    "givenName": "William",
    "familyName": "Smith",
    "address": {
      "streetAddress": "123 Fake St.",
      "city": "Kalamazoo",
      "regionCode": "US-MI",
      "countryCode": "US"
    },
    "phoneNumbers": [
      "+13065551234"
    ],
    "emailAddresses": [
      "example@email.com"
    ],
    "tags": [
      "2021 Christmas Campaign"
    ],
    "permissionToContact": false,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "relationships": {
    "businessLocation": {
      "data": {
        "id": "string",
        "type": "businessLocation"
      }
    }
  }
}