Create custom object definitions

You can post custom object definitions with the request body schema described below.

This operation also allows you to use the List custom object definitions response schema as its request schema. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can make a List custom object definitions call in your old tenant and then use its response directly as the request of this operation in the new tenant to import all the custom objects from the old tenant.

The label field is the UI label of the custom object. The object field contains the API Name of the custom object.


This custom object definition has the following limitations:

  • The maximum number of characters for the Custom Object API Name (object) is 64.
  • The maximum number of characters for the Custom Object Label (label) is 64.
  • The maximum number of characters for the Custom Object Description 250.
  • The maximum number of custom fields in an custom object is 50.
  • The maximum number of characters for the custom field API name is 64.
  • The maximum number of characters for the custom field label (label) is 64.
  • The maximum number of characters for the custom field Description is 250.
  • The maximum number of picklist or multiselect options is 250.
  • The default maximum number of characters for the Text field is 512. You can configure the max length up to 8,192 characters when creating or updating the custom object definition via API. However, if the Text field is filterable, the max length must be 512 or less.
  • The maximum number of digits to the left of the decimal point for the Number field is 13, and to the right is 9.
header Parameters
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.


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.


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.

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


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.


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

string <date>

API version that determines the response schema. The default version is used if this parameter is not included. Specify Zuora-Version in the request header if you expect a specific response schema.

Request Body schema: application/json

The custom object definitions to be created

object (customObjectDefinitions)

The custom object definitions. This object maps types to custom object definitions.




Bad request

Request samples
  • "definitions": {
Response samples
  • "count": 2,
  • "definitions": {