Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13171054.0 KB
customers

Updates a customer account's settings. This method supports patch semantics. You cannot update customerType via the Reseller API, but a "team" customer can verify their domain and become customerType = "domain". For more information, see Verify your domain to unlock Essentials features.

patch/apps/reseller/v1/customers/{customerId}

Path parameters

customerIdstring required

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.

Request body

customerDomainstring

The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.

customerType'customerTypeUnspecified' | 'domain' | 'team'

Identifies the type of the customer. Acceptable values include: * domain: Implies a domain-verified customer (default). * team: Implies an email-verified customer. For more information, see managed teams.

customerDomainVerifiedboolean

Whether the customer's primary domain has been verified.

kindstring

Identifies the resource as a customer. Value: reseller#customer

customerIdstring

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

alternateEmailstring

Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new "domain" customer and should not use the same domain as customerDomain. The alternateEmail field is not necessary to create a "team" customer.

resourceUiUrlstring

URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.

phoneNumberstring

Customer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.

Response

Successful response