Patch
|
|||||
|
|
||||
Update a customer account's settings. This method supports patch semantics
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage users on your domain
Input
This building block consumes 19 input parameters
| Name | Format | Description |
|---|---|---|
customerId Required |
STRING |
Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates |
alternateEmail |
STRING |
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 customer and should not use the same domain as customerDomain |
customerDomain |
STRING |
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 |
customerDomainVerified |
BOOLEAN |
Whether the customer's primary domain has been verified |
customerId |
STRING |
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 |
kind |
STRING |
Identifies the resource as a customer. Value: reseller#customer |
phoneNumber |
STRING |
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 |
postalAddress |
OBJECT |
JSON template for address of a customer |
postalAddress.addressLine1 |
STRING |
A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional |
postalAddress.addressLine2 |
STRING |
Line 2 of the address |
postalAddress.addressLine3 |
STRING |
Line 3 of the address |
postalAddress.contactName |
STRING |
The customer contact's name. This is required |
postalAddress.countryCode |
STRING |
For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer |
postalAddress.kind |
STRING |
Identifies the resource as a customer address. Value: customers#address |
postalAddress.locality |
STRING |
An example of a locality value is the city of San Francisco |
postalAddress.organizationName |
STRING |
The company or company division name. This is required |
postalAddress.postalCode |
STRING |
A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer |
postalAddress.region |
STRING |
An example of a region value is CA for the state of California |
resourceUiUrl |
STRING |
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 |
= Parameter name
= Format
|
customerId STRING Required Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates |
|
alternateEmail STRING 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 customer and should not use the same domain as customerDomain |
|
customerDomain STRING 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 |
|
customerDomainVerified BOOLEAN Whether the customer's primary domain has been verified |
|
customerId STRING 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 |
|
kind STRING Identifies the resource as a customer. Value: reseller#customer |
|
phoneNumber STRING 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 |
|
postalAddress OBJECT JSON template for address of a customer |
|
postalAddress.addressLine1 STRING A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional |
|
postalAddress.addressLine2 STRING Line 2 of the address |
|
postalAddress.addressLine3 STRING Line 3 of the address |
|
postalAddress.contactName STRING The customer contact's name. This is required |
|
postalAddress.countryCode STRING For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer |
|
postalAddress.kind STRING Identifies the resource as a customer address. Value: customers#address |
|
postalAddress.locality STRING An example of a locality value is the city of San Francisco |
|
postalAddress.organizationName STRING The company or company division name. This is required |
|
postalAddress.postalCode STRING A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer |
|
postalAddress.region STRING An example of a region value is CA for the state of California |
|
resourceUiUrl STRING 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 |
Output
This building block provides 18 output parameters
| Name | Format | Description |
|---|---|---|
alternateEmail |
STRING |
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 customer and should not use the same domain as customerDomain |
customerDomain |
STRING |
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 |
customerDomainVerified |
BOOLEAN |
Whether the customer's primary domain has been verified |
customerId |
STRING |
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 |
kind |
STRING |
Identifies the resource as a customer. Value: reseller#customer |
phoneNumber |
STRING |
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 |
postalAddress |
OBJECT |
JSON template for address of a customer |
postalAddress.addressLine1 |
STRING |
A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional |
postalAddress.addressLine2 |
STRING |
Line 2 of the address |
postalAddress.addressLine3 |
STRING |
Line 3 of the address |
postalAddress.contactName |
STRING |
The customer contact's name. This is required |
postalAddress.countryCode |
STRING |
For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer |
postalAddress.kind |
STRING |
Identifies the resource as a customer address. Value: customers#address |
postalAddress.locality |
STRING |
An example of a locality value is the city of San Francisco |
postalAddress.organizationName |
STRING |
The company or company division name. This is required |
postalAddress.postalCode |
STRING |
A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer |
postalAddress.region |
STRING |
An example of a region value is CA for the state of California |
resourceUiUrl |
STRING |
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 |
= Parameter name
= Format
|
alternateEmail STRING 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 customer and should not use the same domain as customerDomain |
|
customerDomain STRING 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 |
|
customerDomainVerified BOOLEAN Whether the customer's primary domain has been verified |
|
customerId STRING 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 |
|
kind STRING Identifies the resource as a customer. Value: reseller#customer |
|
phoneNumber STRING 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 |
|
postalAddress OBJECT JSON template for address of a customer |
|
postalAddress.addressLine1 STRING A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional |
|
postalAddress.addressLine2 STRING Line 2 of the address |
|
postalAddress.addressLine3 STRING Line 3 of the address |
|
postalAddress.contactName STRING The customer contact's name. This is required |
|
postalAddress.countryCode STRING For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer |
|
postalAddress.kind STRING Identifies the resource as a customer address. Value: customers#address |
|
postalAddress.locality STRING An example of a locality value is the city of San Francisco |
|
postalAddress.organizationName STRING The company or company division name. This is required |
|
postalAddress.postalCode STRING A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer |
|
postalAddress.region STRING An example of a region value is CA for the state of California |
|
resourceUiUrl STRING 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 |