Compare and deploy a source tenant to a target tenant

Compare and deploy a source tenant to a target tenant.

Request
header Parameters
Zuora-Entity-Ids
string

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.

Request Body schema: multipart/form-data
required
customFields
required
boolean

Specified if customFields module should be considered in the deployment process.

description
required
string

Deployment's description.

name
required
string

Deployment's name.

notifications
required
boolean

Specified if notifications module should be considered in the deployment process.

productCatalog
required
boolean

Specified if productCatalog module should be considered in the deployment process.

reporting
required
boolean

Specified if reporting module should be considered in the deployment process.

sendEmail
required
boolean

Specifies if an email should be sent.

settings
required
boolean

Specified if settings module should be considered in the deployment process.

sourceTenantId
required
string

Id of the source tenant.

userRoles
required
boolean

Specified if userRoles module should be considered in the deployment process.

workflows
required
boolean

Specified if workflows module should be considered in the deployment process.

emails
string

If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com.

comments
string

Content of the email to be sent.

customObjects
boolean

Specified if customObjects module should be considered in the deployment process.

taxation
boolean

Specified if taxation module should be considered in the deployment process.

Responses
200
400

Validation of dependent module error.

post/deployment-manager/deployments/tenants
Request samples
Response samples
application/json
{
  • "id": "8039d54b-da6f-4d80-88d5-06220c42861f",
  • "status": "DEPLOYING"
}