Create custom object definitions

POST

/objects/definitions/default

POST

/objects/definitions/default

from zuora import ZuoraClient, PostCustomObjectDefinitionsRequestDefinition, PostCustomObjectDefinitionFieldDefinitionRequest, PostCustomObjectDefinitionsRequestDefinitionRelationshipsItem
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.custom_object_definitions.post_custom_object_definitions(
    definitions={
        "Vehicle": PostCustomObjectDefinitionsRequestDefinition(
            label="Vehicle",
            object="Vehicle",
            properties={
                "DeviceId__c": PostCustomObjectDefinitionFieldDefinitionRequest(
                    label="Device ID",
                    max_length=20,
                    type="string",
                ),
                "OrderId__c": PostCustomObjectDefinitionFieldDefinitionRequest(
                    format="uuid",
                    label="Order ID",
                    type="string",
                )
            },
            relationships=[
                PostCustomObjectDefinitionsRequestDefinitionRelationshipsItem(
                    fields={
                        "OrderId__c": "Id"
                    },
                    namespace="com_zuora",
                    object="orders",
                )
            ],
        )
    },
)

{
  "CreatedById": "8ad084a67f9c7138017fab8a8b511b5a",
  "CreatedDate": "2024-11-15T06:13:27.338Z",
  "Id": "f67635c8-094e-4ffc-90be-5dba5c639494",
  "UpdatedById": "8ad084a67f9c7138017fab8a8b511b5a",
  "UpdatedDate": "2024-11-15T06:13:27.338Z",
  "schema": {
    "enableCreateRecordAuditing": false,
    "enableDeleteRecordAuditing": false,
    "enableRecordMigration": false,
    "filterable": [
      "OrderId__c",
      "Id",
      "CreatedDate",
      "UpdatedDate"
    ],
    "label": "Vehicle",
    "object": "Vehicle",
    "properties": {
      "CreatedById": {
        "label": "CreatedById",
        "origin": "system",
        "type": "string"
      },
      "CreatedDate": {
        "format": "date-time",
        "label": "CreatedDate",
        "origin": "system",
        "type": "string"
      },
      "DeviceId__c": {
        "label": "Device ID",
        "maxLength": 20,
        "origin": "custom",
        "type": "string"
      },
      "Id": {
        "format": "uuid",
        "label": "Id",
        "origin": "system",
        "type": "string"
      },
      "OrderId__c": {
        "format": "uuid",
        "label": "Order ID",
        "origin": "custom",
        "type": "string"
      },
      "UpdatedById": {
        "label": "UpdatedById",
        "origin": "system",
        "type": "string"
      },
      "UpdatedDate": {
        "format": "date-time",
        "label": "UpdatedDate",
        "origin": "system",
        "type": "string"
      }
    },
    "relationships": [
      {
        "cardinality": "manyToOne",
        "fields": {
          "OrderId__c": "Id"
        },
        "namespace": "com_zuora",
        "object": "orders",
        "recordConstraints": {
          "create": {
            "enforceValidMapping": true
          }
        }
      },
      {
        "cardinality": "manyToOne",
        "fields": {
          "CreatedById": "Id"
        },
        "namespace": "com_zuora",
        "object": "User",
        "recordConstraints": {
          "create": {
            "enforceValidMapping": true
          }
        }
      },
      {
        "cardinality": "manyToOne",
        "fields": {
          "UpdatedById": "Id"
        },
        "namespace": "com_zuora",
        "object": "User",
        "recordConstraints": {
          "create": {
            "enforceValidMapping": true
          }
        }
      }
    ],
    "required": [
      "Id",
      "CreatedById",
      "UpdatedById",
      "CreatedDate",
      "UpdatedDate"
    ]
  },
  "type": "Vehicle"
}

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.

Limitations

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 maximum length of characters for the Text field is 255.
The maximum length of characters for the Long Text field is from 256 to 8,192.
The maximum number of digits to the left of the decimal point for the Number field is 13, and to the right is 9.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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

Request

The custom object definitions to be created

definitionsmap from strings to objectsOptional

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

Response headers

Content-EncodingstringOptional

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

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

countintegerOptional

The number of objects in the definitions object. The value of this field is the number of custom object definitions in the namespace.

definitionsmap from strings to objectsOptional

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

Errors

400

Bad Request Error