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 Jobs API

With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch.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 Jobs 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 Jobs 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 Jobs. The published artifact set on APIs.io includes an OpenAPI specification.

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

6 operations 5 paths 10 schemas 3 GET1 PATCH2 POST

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 6

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

Custom Object Jobs 6

With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch. If you use Postman, you can import the custom objects…

POST
/objects/jobs
Submit a custom object bulk job
POST_CustomObjectBulkJob 9 params → 200400403
GET
/objects/jobs
List all custom object bulk jobs
GET_AllCustomObjectBulkJobs 10 params → 200
GET
/objects/jobs/{id}
Retrieve a custom object bulk job
GET_CustomObjectBulkJob 8 params → 200404
POST
/objects/jobs/{id}/files
Upload a file for a custom object bulk job
POST_UploadFileForCustomObjectBulkJob 11 params → 200400404403
GET
/objects/jobs/{id}/errors
List all errors for a custom object bulk job
GET_CustomObjectBulkJobErrors 8 params → 200404
PATCH
/objects/jobs/{id}/cancel
Cancel a custom object bulk job
PATCH_CustomObjectBulkJob 9 params → 200400404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CustomObjectBulkJobResponse (12 properties), CustomObjectBulkJobErrorResponse (4 properties), CommonErrorResponse (4 properties), CustomObjectBulkJobRequest (4 properties). Each schema is shown below with its type and property counts.

CustomObjectBulkDeleteFilterCondition
object
Condition evaluated on a single object field
3 properties 3 required
CommonErrorResponse
object
4 properties
CustomObjectBulkJobErrorResponse
object
4 properties
CustomObjectBulkJobErrorResponseCollection
object
1 property 1 required
CustomObjectRecordWithOnlyCustomFields
object
CustomObjectBulkJobRequest
object
4 properties 3 required
CustomObjectRecordWithAllFields
object
Record data from an object
CustomObjectBulkJobResponseCollection
object
3 properties 1 required
CustomObjectBulkDeleteFilter
object
Filters to determine which records to be deleted in the bulk delete operation.
1 property 1 required
CustomObjectBulkJobResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-custom-object-jobs-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