Compare and deploy a template to a tenant

Compare and deploy a template to a 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
description
required
string

Deployment's description.

name
required
string

Deployment's name

sendEmail
required
boolean

Specifies if an email should be sent.

template
required
string <binary>

Template file.

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.

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