How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 3.2.0, at version 2023-12-15.

Requests are made against a single base URL, https://rest.zuora.com/.

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 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
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 9 params body → 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 10 params body → 200404
PATCH
/objects/records/default/{object}/{id}
Partially update a custom object record
Patch_PartialUpdateCustomObjectRecord 10 params body → 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 9 params body → 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), CustomObjectRecordsWithError (3 properties), ErrorResponse401Record (3 properties). Each schema is shown below with its type and property counts.

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

This is an independent, third-party profile of Zuora Custom Object Records API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.