PUT /v1/accounts/{account-key}

Updates a customer account by specifying the account-key.

Notes

Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.
If an empty field is submitted with this operation, the corresponding field in the account is emptied.
Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the personalEmail or workEmail of billToContact is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to true. (In that case, emails go to the workEmail address, if it exists, or else the personalEmail.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to false.
The bill-to and sold-to contacts are separate data entities. If you select the Same as Bill To Contact check box during account creation, both the Bill To and Sold To contacts are updated upon updating either one because they point to the same contact record. In this case, if you want to update only one of them, you have to first create another contact and update the Bill To or Sold To contact of the customer account to be the newly created one.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`account-key`	String	Yes	Account number or account ID.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
`Zuora-Track-Id`	String	No	A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Zuora-Entity-Ids`	String	No	An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.
`Zuora-Org-Ids`	String	No	Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. If the header is not set, the operation is performed in scope of the user's accessible orgs.
`Accept-Encoding`	String	No	Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.

Request body fields

Name	Type	Required	Description
`creditMemoTemplateId`	String	No	Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information. The unique ID of the credit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
`defaultPaymentMethodId`	String	No	ID of the default payment method for the account. Values: a valid ID for an existing payment method.
`billCycleDay`	Integer	No	Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed. Values: Any activated system-defined bill cycle day （`1`-`31`）
`sequenceSetId`	String	No	The ID of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set.
`SynctoNetSuite__NS`	String	No	Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite. Possible values: `"Yes"` `"No"`
`Class__NS`	String	No	Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`parentId`	String	No	Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled.
`SyncDate__NS`	String	No	Date when the account was sychronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`customerServiceRepName`	String	No	Name of the account’s customer service representative, if applicable.
`salesRep`	String	No	The name of the sales representative associated with this account, if applicable. Maximum of 50 characters.
`invoiceDeliveryPrefsPrint`	Boolean	No	Whether the customer wants to receive printed invoices, such as through postal mail. The default value is `false`.
`autoPay`	Boolean	No	Whether future payments are to be automatically billed when they are due.
`additionalEmailAddresses[]`	Array	No	A list of additional email addresses to receive email notifications. Use commas to separate email addresses.
`tagging`	String	No
`IntegrationStatus__NS`	String	No	Status of the account's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`IntegrationId__NS`	String	No	ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`invoiceDeliveryPrefsEmail`	Boolean	No	Whether the customer wants to receive invoices through email. The default value is `false`.
`crmId`	String	No	CRM account ID for the account, up to 100 characters.
`Department__NS`	String	No	Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`paymentTerm`	String	No	Payment terms for this account. Possible values are `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`.
`invoiceTemplateId`	String	No	Invoice template ID, configured in Billing Settings in the Zuora UI.
`purchaseOrderNumber`	String	No	The purchase order number provided by your customer for services, products, or both purchased.
`CustomerType__NS`	String	No	Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the Zuora Connector for NetSuite. Possible values: `"Company"` `"Individual"`
`partnerAccount`	Boolean	No	Whether the customer account is a partner, distributor, or reseller. You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments. Note: This field is available only if you have the Reseller Account feature enabled. Default value: false
`paymentGateway`	String	No	The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway.
`debitMemoTemplateId`	String	No	Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information. The unique ID of the debit memo template, configured in Billing Settings > Manage Billing Document Configuration through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
`name`	String	No	Account name, up to 255 characters.
`communicationProfileId`	String	No	The ID of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile.
`notes`	String	No	A string of up to 65,535 characters.
`taxInfo`	Object	No	Container for tax exempt information, used to establish the tax exempt status of a customer account.
`taxInfo.exemptCertificateType`	String	No	Type of tax exemption certificate that the customer holds. Requires Zuora Tax.
`taxInfo.VATId`	String	No	EU Value Added Tax ID. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.
`taxInfo.exemptCertificateId`	String	No	ID of the customer tax exemption certificate. Requires Zuora Tax.
`taxInfo.companyCode`	String	No	Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.
`taxInfo.exemptIssuingJurisdiction`	String	No	Jurisdiction in which the customer tax exemption certificate was issued.
`taxInfo.exemptStatus`	String	No	Status of the account tax exemption. Requires Zuora Tax. Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used. Values: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input.
`taxInfo.exemptDescription`	String	No	Description of the tax exemption certificate that the customer holds. Requires Zuora Tax.
`taxInfo.exemptEffectiveDate`	String	No	Date when the customer tax exemption starts. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date.
`taxInfo.exemptEntityUseCode`	String	No	A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See Exempt Transactionsfor more details.
`taxInfo.exemptExpirationDate`	String	No	Date when the customer tax exemption expires. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date.
`profileNumber`	String	No	The number of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile.
`Location__NS`	String	No	Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`batch`	String	No	The alias name given to a batch. A string of 50 characters or less. Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
`Subsidiary__NS`	String	No	Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the Zuora Connector for NetSuite.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.