Sign in
Custom Object Definitions

Update an object definition

Updates custom object definitions or custom field definitions for standard and custom objects.

The system asynchronously processes requests to update custom object definitions or advanced custom field definitions and returns a jobId in the response. You can use the “Retrieve a custom object bulk job” operation to check whether the asynchronous job is completed. For more information about advanced custom fields, see <a href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-fields-and-legacy-custom-fields" target="_blank">Custom fields and legacy custom fields</a>.

Limitations

Updating custom field definition has the following limitations:

  • You can only have one action per update request.
  • You cannot delete fields from custom objects that contain records.
  • You can only add required fields to custom objects with no records.
  • You can change optional fields to required only on the custom objects with no records.

Note

The bulk deletion of custom fields on standard and custom objects is temporarily unavailable as we refine the Custom Field feature.

You can still delete custom fields individually during this refinement process. If you want to delete multiple custom fields, ensure that you send each deletion request only after receiving the response for the previous request.

The bulk deletion capability will be restored once the refinement is complete.

post/objects/migrations

Headers

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.

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

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

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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.

Zuora-Versionstring 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

Example request

{
  "actions": [
    {
      "field": {
        "definition": {
          "description": "Address zip code",
          "label": "Zip code",
          "maxLength": 10,
          "type": "string"
        },
        "name": "zip__c"
      },
      "namespace": "default",
      "object": "address",
      "type": "addField"
    }
  ]
}

Response

OK

jobIdstring uuid

The ID of the asynchronous job. It is available only when updating custom object definitions or advanced custom field definitions.

Use the “Retrieve a custom object bulk job” operation to check whether the asynchronous job is completed.

Example response

{
  "actions": [
    {
      "field": {
        "definition": {
          "description": "Address zip code",
          "label": "Zip code",
          "maxLength": 10,
          "type": "string"
        },
        "name": "zip__c"
      },
      "namespace": "default",
      "object": "address",
      "type": "addField"
    }
  ]
}

Changes