Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Custom Object Records API

With Custom Objects service, you can create, update, delete and find custom object records.If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works. Click the following button to get started:[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1f068ba43651bf63c0d4)You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet.Note that the Custom Object Records API is versioned by `Zuora-Version` in the request header. The response may be different for the same request with a different API version. Specify `Zuora-Version` in the request header if you expect a specific response schema.### Error handling If the Custom Objects API call fails, an error code will be returned in the response body. See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code) for details.

Zuora Custom Object Records API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Object Records. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

7 operations 3 paths 15 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Object Records 7

With Custom Objects service, you can create, update, delete and find custom object records. If you use Postman, you can import the custom objects endpoints as a collection into yo…

POST
/objects/records/default/{object}
Create custom object records
POST_CustomObjectRecords 10 params → 200400401500
GET
/objects/records/default/{object}
List records for a custom object
GET_AllRecordsForCustomObjectType 12 params → 200
GET
/objects/records/default/{object}/{id}
Retrieve a custom object record
GET_CustomObjectRecordByID 9 params → 200404
PUT
/objects/records/default/{object}/{id}
Update a custom object record
PUT_CustomObjectRecord 11 params → 200404
PATCH
/objects/records/default/{object}/{id}
Partially update a custom object record
Patch_PartialUpdateCustomObjectRecord 11 params → 200404
DELETE
/objects/records/default/{object}/{id}
Delete a custom object record
Delete_CustomObjectRecordByID 9 params → 200
POST
/objects/batch/default/{object}
Update or delete custom object records
POST_CustomObjectRecordsBatchUpdateOrDelete 10 params → 200400401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CommonErrorResponse (4 properties), CustomObjectRecordBatchAction (4 properties), CustomObjectRecordsErrorResponse (3 properties), ErrorResponse401Record (3 properties). Each schema is shown below with its type and property counts.

CommonErrorResponse
object
4 properties
CustomObjectRecordBatchRequest
object
Request of processing custom object records in batch.
1 property 1 required
CustomObjectRecordsWithError
object
3 properties
ErrorResponse401Record
object
3 properties
CustomObjectRecordBatchUpdateMapping
object
Object records that you want to update. Only applicable when type is update.
PostCustomObjectRecordsRequest
object
2 properties 1 required
CustomObjectRecordsThrottledResponse
object
3 properties
CustomObjectRecordBatchAction
object
The batch action on custom object records
4 properties 1 required
CustomObjectRecordsErrorResponse
object
3 properties
Error401
object
2 properties
CustomObjectRecordWithOnlyCustomFields
object
CustomObjectRecordsBatchUpdatePartialSuccessResponse
object
1 property
QueryCustomObjectRecordsResponse
object
2 properties 2 required
CustomObjectRecordWithAllFields
object
Record data from an object
PostCustomObjectRecordsResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-custom-object-records-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Billing Preview Run API