Skip to content
Legacy API Reference
/
/
Transfer report ownership

Transfer report ownership

Request

Transfers ownership of one or more reports to a different user.

You can transfer ownership using either reportNames or reportIds.

Authorization requirement:
The user who obtains the OAuth token must have the Zuora Reporting Administrator role.

To get the userId of the new owner, navigate to:
Administration Settings > Manage Users > Click the new owner name > In the URL, locate the id value:
https://{zuora_endpoint}/apps/UserLogin.do?method=view&id=<userId>&...

That id is the newOwnerUserId.

For detailed usage examples including curl commands, see the Transfer Report Ownership Zuora Knowledge Center article.

Headers
Idempotency-Keystring, <= 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-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.

Authorizationstringrequired

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Idstring, <= 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 (').

Bodyapplication/jsonrequired
reportNamesArray of strings

List of report names to transfer.
Optional if reportIds is supplied.

Example:
[
  "Report 1",
  "Report 2"
]
reportIdsArray of strings

List of report IDs to transfer.
Optional if reportNames is supplied.

newOwnerUserIdstringrequired

Unique identifier of the new owner (see "Finding newOwnerUserId" in the description of this operation).

Example:"4c85f2b42ba949569a5d15e77c6b9742"
{
  "reportNames": [
    "Report 1",
    "Report 2"
  ],
  "newOwnerUserId": "4c85f2b42ba949569a5d15e77c6b9742"
}

Responses

Ownership transfer was successful.

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Supported MIME types for gzip:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call.

Bodyapplication/json
Response
{
  "success": true,
  "response": "Transfer ownership successfully"
}