Submit a custom object bulk job

Submits a bulk job request for a bulk operation on the specified custom object records. A succcessful call returns a newly created bulk job. The job ID can be used to poll the job status or upload the CSV file if it is a create or update job.

Limits

This custom object bulk jobs have the following limits:

  • The concurrent bulk job limit per tenant is 5. Bulk jobs in accepted, pending, or in_progress status are counted towards the concurrent bulk job limit.
  • The bulk job execuation order is not guaranteed, which means the bulk job that you submit ealier may be executed later.
  • Only the users that have the "Delete Custom Objects" permission can create a delete bulk job. Only the users that have the "Edit Custom Objects" permission can create a create or update bulk job. See Platform Permissions for more information.
Request
header Parameters
Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

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-Encoding
string

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-Id
string <= 64 characters

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-Ids
string

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 do not need to set this header.

Zuora-Org-Ids
string

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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Version
string <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 schema: application/json
required

Custom Objects bulk job request

operation
required
string

The operation that the bulk job performs. Only the users that have the "Delete Custom Objects" permission can submit a delete bulk job request. Only the users that have the "Edit Custom Objects" permission can submit a create or update bulk job request. See Platform Permissions for more information.

Enum: "delete" "create" "update"
object
required
string

The object that the bulk operation performs on.

namespace
required
string

The namespace of the object. Custom objects belong to the default namespace. Zuora standard objects belong to the com_zuora namespace. Bulk job operations on the following Zuora standard objects are supported:

  • SavedQuery
Enum: "default" "com_zuora"
object (CustomObjectBulkDeleteFilter)

Filters to determine which records to be deleted in the bulk delete operation.

Responses
200

OK

400

Invalid input

403

Unauthorized

post/objects/jobs
Request samples
application/json
{
  • "filter": {
    },
  • "namespace": "default",
  • "object": "passenger",
  • "operation": "delete"
}
Response samples
application/json
{
  • "CreatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
  • "CreatedDate": "2021-03-15T06:47:18Z",
  • "Id": "ed4b9701-bafb-4976-8019-b08269430153",
  • "UpdatedById": "7b39d73f-22e6-404a-b8e7-894f7620e91c",
  • "UpdatedDate": "2021-03-15T06:47:18Z",
  • "error": {
    },
  • "namespace": "default",
  • "object": "passenger",
  • "operation": "delete",
  • "processingTime": 1882,
  • "recordsProcessed": 500,
  • "status": "failed"
}