create-customer-request.md

Create Customer Request

Defines the body parameters that can be included in a request to the CreateCustomer endpoint.

Structure

Create Customer Request

Fields

Name	Type	Tags	Description
idempotency_key	string	Optional	The idempotency key for the request. For more information, see Idempotency.
given_name	string	Optional	The given name (that is, the first name) associated with the customer profile.
family_name	string	Optional	The family name (that is, the last name) associated with the customer profile.
company_name	string	Optional	A business name associated with the customer profile.
nickname	string	Optional	A nickname for the customer profile.
email_address	string	Optional	The email address associated with the customer profile.
address	Address	Optional	Represents a physical address.
phone_number	string	Optional	The 11-digit phone number associated with the customer profile.
reference_id	string	Optional	An optional second ID used to associate the customer profile with an entity in another system.
note	string	Optional	A custom note associated with the customer profile.
birthday	string	Optional	The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed. For example, 0000-09-21T00:00:00-00:00 represents a birthday on September 21 and 1998-09-21T00:00:00-00:00 represents a birthday on September 21, 1998. You can also specify this value in YYYY-MM-DD format.

Example (as JSON)

{
  "address": {
    "address_line_1": "500 Electric Ave",
    "address_line_2": "Suite 600",
    "administrative_district_level_1": "NY",
    "country": "US",
    "locality": "New York",
    "postal_code": "10003"
  },
  "email_address": "Amelia.Earhart@example.com",
  "family_name": "Earhart",
  "given_name": "Amelia",
  "note": "a customer",
  "phone_number": "1-212-555-4240",
  "reference_id": "YOUR_REFERENCE_ID"
}