The Customer object

This object represents a customer of your business.

{
  "id": "ZvohVUmUXJ4ZpXFCTt2A",
  "phoneNumber": "[phone]",
  "firstName": "Ali",
  "lastName": "Koch",
  "alias": "A. Koch",
  "dob": "2010-08-14",
  "pronoun": "she",
  "gender": "male",
  "sex": "male",
  "preferredLanguage": "en",
  "email": "[email protected]",
  "bio": "Ali Koch is a developer with a passion for creating applications.",
  "address": {
    "formatted": "45 Rockefeller plaza, New York, NY, USA",
    "timezone": "America/New_York"
  },
  "facebookProfileURL": "https://facebook.com/alikock2010",
  "instagramProfileURL": "https://instagram.com/alikock2010",
  "channel": "facebook",
  "workplaceId": "qyHTeXnnPa7Run2hGz1V",
  "tags": ["no-calls"],
  "createdAt": "2024-05-14T14:15:36Z",
  "updatedAt": "2024-05-14T14:15:36Z"
}

Attributes

• id (string): A unique identifier for the customer.

• phoneNumber (string): The customer's phone number.

• firstName (string): The first name of the customer.

• lastName (string): The last name of the customer.

• alias (string): An alias or nickname for the customer.

• dob (string, format: date): The customer's date of birth in full-date notation as defined by RFC 3339, section 5.6 (e.g., 2017-07-21).

• pronoun (string): The pronoun the customer prefers.

• gender (string): The customer's gender identity.

• sex (string): The biological sex of the customer. Valid values are:

  • "male"

  • "female"

  • "intersex"

  • "unknown"

• preferredLanguage (string): The customer's preferred language. Valid values are:

  • "en" (English)

  • "es" (Spanish)

• email (string): The customer's email address.

• bio (string): A brief biography of the customer.

• address (object): The customer's address information, which includes:

  • formatted (string): The full address.

  • timezone (string): The timezone of the address.

• facebookProfileURL (string): The URL of the customer's Facebook profile.

• instagramProfileURL (string): The URL of the customer's Instagram profile.

• channel (string): The marketing channel associated with the customer.

• workplaceId (string): The The ID of the primary Workplace where the customer works.

• tags (array of strings): A list of tags that describe the customer.

• createdAt (string, format: date-time): The date and time when the customer record was created, in the date-time notation as defined by RFC 3339 (e.g., 2017-07-21T17:32:28Z).

• updatedAt (string, format: date-time): The date and time when the customer record was last updated, in the date-time notation as defined by RFC 3339 (e.g., 2017-07-21T17:32:28Z).