REST Resource: customers

Resource: Customer

JSON representation
{
  "id": string,
  "customerDomain": string,
  "kind": string,
  "etag": string,
  "alternateEmail": string,
  "customerCreationTime": string,
  "postalAddress": {
    object (CustomerPostalAddress)
  },
  "phoneNumber": string,
  "language": string
}
Fields
id

string

The unique ID for the customer's Google Workspace account. (Readonly)

customerDomain

string

The customer's primary domain name string. Do not include the www prefix when creating a new customer.

kind

string

Identifies the resource as a customer. Value: admin#directory#customer

etag

string

ETag of the resource.

alternateEmail

string

The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain

customerCreationTime

string

The customer's creation time (Readonly)

postalAddress

object (CustomerPostalAddress)

The customer's postal address information.

phoneNumber

string

The customer's contact phone number in E.164 format.

language

string

The customer's ISO 639-2 language code. See the Language Codes page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is en.

CustomerPostalAddress

JSON representation
{
  "countryCode": string,
  "addressLine2": string,
  "region": string,
  "addressLine3": string,
  "locality": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
Fields
countryCode

string

This is a required property. For countryCode information see the ISO 3166 country code elements.

addressLine2

string

Address line 2 of the address.

region

string

Name of the region. An example of a region value is NY for the state of New York.

addressLine3

string

Address line 3 of the address.

locality

string

Name of the locality. An example of a locality value is the city of San Francisco.

postalCode

string

The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.

addressLine1

string

A customer's physical address. The address can be composed of one to three lines.

organizationName

string

The company or company division name.

contactName

string

The customer contact's name.

Methods

get

Retrieves a customer.

patch

Patch Customers via Apiary Patch Orchestration

update

Updates a customer.