Sign in
Configuration Templates

Create a deployment template

Creates templates based on user preference. There are 2 ways to select components.

  • Selecting the whole component.
  • Advanced Options -> which helps user to select specific components to be migrated.

It takes the enviroment details from the logged in user automatically, while creating the template.

post/deployment-manager/deployment_templates

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

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-Encodingstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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-Idstring

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 body

customFieldsboolean

Selected custom fields component or not.

customObjectsboolean

Selected custom objects component or not.

descriptionstring required

Creates template description.

namestring required

Name of the Template.

notificationsboolean

Selected Notification component or not.

settingsboolean

Selected Settings component or not.

templateTenantstring required

ID of the template tenant.

workflowsboolean

Selected Workflow component or not.

Example request

{
  "templateTenant": "80b3f8cd-5801-4ed7-bee7-ad1569916c2f"
}

Response

Successfully created the template.

activeboolean

Whether or not the template is active.

createdBystring

Information about the user who created it.

createdOnstring

When it is created.

descriptionstring

Template description which contains the information about the created template.

entityNamestring

Name of the Entity

environmentstring

Details of the environment in which the template was created.

errorsstring

Error information.

idstring

Id of the template.

namestring

Name of the template.

statusstring

The status of the template creation, such as whether it is in progress, completed, or failed.

tenantNamestring

Tenant's name for whom the template is created.

Changes