Sign in
Notifications

Retrieve a reusable block

Queries the reusable block based on the specified ID or name.

get/notifications/reusable-blocks/{blockKey}

Path parameters

blockKeystring required

The ID or name of the reusable block.

Headers

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

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.

Response

OK

activeboolean

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

category'Headers' | 'Footers' | 'Other'

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

contentstring

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

createdBystring uuid

The ID of the user who created the reusable block.

createdOnstring date-time

The time when the reusable block was created.

idstring uuid

The ID of the reusable block.

namestring

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

numberstring

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.

tagsstring[]

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

updatedBystring uuid

The ID of the user who updated the reusable block.

updatedOnstring date-time

TThe time when the reusable block was updated.

Example response

{
  "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)"
}

Changes