Update a catalog group

Note: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

Updates a catalog group by its unique number or ID.

Notes

  • It is best practice to only specify the fields that you want to change in the request body.
  • If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied.
  • The catalog group type cannot be changed.
Request
path Parameters
catalog-group-key
required
string

The unique number or ID of the catalog group to be updated.

header Parameters
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.

Authorization
string

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

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 do not need to 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
Array of objects (add)

The list of product rate plans to be added to the catalog group.

description
string

The description of the catalog group.

name
string

The unique name of the catalog group.

Array of objects (remove)

The list of product rate plans to be removed from the catalog group.

Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/catalog-groups/{catalog-group-key}
Request samples
application/json
{
  • "add": [
    ],
  • "description": "description",
  • "name": "name",
  • "remove": [
    ]
}
Response samples
application/json
{
  • "catalogGroupNumber": "CG-00000001",
  • "description": "some description",
  • "id": "4028e5ab7f1b600c017f1b7a5e8901d2",
  • "name": "test",
  • "productRatePlans": [
    ],
  • "type": "Grading"
}