Sign in
Test Environment Notifications

Update a test environment notification

Use this operation to update an existing notification for a specific Test Environment. It handles HTTP PATCH requests to the /test-environments/{id}/notifications/{notificationId} endpoint, accepting a TestEnvironmentNotificationRequest object in the request body. Upon successful update, it returns a TestEnvironmentNotificationResponse object.

User Access Permission

You must be assigned the Refresh Central Sandbox permission to run this operation.

patch/test-environments/{id}/notifications/{notificationId}

Path parameters

idstring required

Test Environment ID

notificationIdstring required

Test Environment Notification ID

Headers

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

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.

Request body

addressstring

The email address to receive notifications for the Test Environment when a refresh job has been completed or cancelled

namestring

The name of the recipient who will receive notifications for the Test Environment

Example request

{
  "address": "john.smith@zuora.com",
  "name": "John Smith"
}

Response

Successfully updated a Test Environment notification

addressstring

The email address to receive notifications for the Test Environment when a refresh job has been completed or cancelled

idstring

The unique id (UUID) of the Test Environment notification

namestring

The name of the recipient who will receive notifications for the Test Environment

testEnvironmentIdstring

The unique id (UUID) of the Test Environment

Example response

{
  "address": "john.smith@zuora.com",
  "id": "11111111-1111-1111-1111-111111111111",
  "name": "John Smith",
  "testEnvironmentId": "11111111-1111-1111-1111-111111111111"
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.