Skip to navigation
Deployment ManagerConfiguration Templates

Sync a deployment template with latest changes

View as Markdown
Synchronizes an existing deployment template with the latest changes in the source tenant.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Accept-EncodingstringOptional

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.

Content-EncodingstringOptional

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-Entity-IdsstringOptional

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 should not set this header.

Zuora-Org-IdsstringOptional

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-Track-IdstringOptional<=64 characters

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 (').

Request

This endpoint expects a multipart form.
templateIdstringRequired
The ID of the deployment template to be synced.
targetTenantIdstringRequired
The ID of the target tenant to which the template should be synced.

Response

Successfully synced the template.
activebooleanOptional
Whether or not the template is active.
contentobjectOptional
Provides details about the different components that need to be compared and deployed.
createdBystringOptional
Information about the user who created it.
createdOnstringOptional
When it is created.
descriptionstringOptional
Template description which contains the information about the created template.
entityNamestringOptional
Name of the Entity
environmentstringOptional
Details of the environment in which the template was created.
errorsstringOptional
Error information.
idstringOptional
Id of the template.
namestringOptional
Name of the template.
statusstringOptional
The status of the template creation, such as whether it is in progress, completed, or failed.
tenantNamestringOptional
Tenant's name for whom the template is created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error