Create a reusable block

Creates a reusable block for email templates, such as email headers or footers.

SecuritybearerAuth
Request
header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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

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

Zuora-Org-Ids
string

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.

Request Body schema: application/json
required

The request body to create a reusable block.

active
boolean
Default: true

The status of the reusable block. Only active blocks can be embedded into email templates.

category
required
string

The category of the reusable block. You can filter blocks by category when editing email templates in the UI.

Enum: "Headers" "Footers" "Other"
content
required
string

The content of the reusable block, which is automatically inserted into email templates when sending email notifications.

name
required
string

The name of the reusable block. The value must be unique across all blocks.

number
string

The number of the reusable block. The value must be unique across all blocks.

If not specified, a unique value will be provided by default.

tags
Array of strings

List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter.

Responses
200

OK

400

Bad Request

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

500

Internal Server Error

post/notifications/reusable-blocks
Request samples
application/json
{
  • "name": "Header Block",
  • "category": "Headers",
  • "content": "(The content of the block)"
}
Response samples
application/json
{
  • "id": "c6af751e4a0041eebb000c51e95e6c2d",
  • "createdBy": "8a90e08282f4ed040182f67bab2902ff",
  • "createdOn": "2025-04-22T08:17:24.000 UTC",
  • "updatedBy": "8a90e08282f4ed040182f67bab2902ff",
  • "updatedOn": "2025-04-22T08:17:24.000 UTC",
  • "active": true,
  • "name": "Header Block",
  • "number": "RB-00000010",
  • "category": "Headers",
  • "tags": [ ],
  • "content": "(The content of the block)"
}