Submit a bulk job for processing

Submits a bulk job for processing by sending a POST request to this URI. The request body contains the job details. Once submitted, the job will be processed based on the provided data.

SecuritybearerAuth
Request
path Parameters
id
required
string

Bulk Job ID

header Parameters
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-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 should not 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-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 (').

Request Body schema: application/json
name
required
string

Name of the job. Max length is 255 characters

objectType
required
string

Type of the object. Supported object types: account, accountingcode, accountingperiod, amendment, bill-run, bill-run-batches, bill-run-filters, contact, credit-memo, credit-memo-from-charge, credit-memo-from-invoice, debit-memo, debit-memo-from-charge, debit-memo-from-invoice, invoice, journal-entry, journal-run, offer, omni-channel-subscription, order, order-create-order-line-item, order-create-subscription-existing-account, order-create-subscription-existing-account-with-volume-charge, order-create-subscription-with-new-account, order-remove-product, order-update-subscription-add-product, order-update-subscription-change-plan, order-update-subscription-price-quantity-change, payment, payment-profile, payment-schedule, payment-schedule-item, payments-simple, payments-unapply, price-book-item, product, product-charge-definition, product-rate-plan, product-rate-plan-charge, product-rate-plan-charge-tier, product-rate-plan-definition, refund, revenue-accounting-code, subscription, subscription-add-rate-plan, subscription-change-rate-plan, subscription-remove-rate-plan, subscription-update-rate-plan, taxation-item, unitofmeasure, usage

description
string

Short description of the job. Max length is 255 characters

Array of objects

List of mappings. Each mapping maps a column in the source file to a field in the template for the corresponding object type

headers
Array of strings

List of headers in the source file. Required if the source file does not have a header row.

rowIdHeader
string

Header in the source file that contains the row id.

delimiter
string

Delimiter used in the source file. Default is comma. Supported values: comma, tab, pipe, semicolon, colon, caret, tilde, dot/period

hasHeaders
boolean

Indicates if the source file has a header row. Default is false

fileType
string

Type of the source file. Supported values: csv, jsonl Default is csv, which means delimited file where the delimiter can be comma but can also be one of the other supported delimiters

Enum: "csv" "jsonl"
jobType
string

Type of the bulk job being created. Default is IMPORT

Enum: "Import" "Delete" "Update" "Cancel"
isCustomObject
boolean

Indicates if the object type is a custom object. Default is false

customObjectNamespace
string

Namespace of the custom object. Applicable only when isCustomObject is true. Default namespace is 'default'.

Responses
200

Job successfully submitted

post/bulk-jobs/{id}/submissions
Request samples
application/json
{
  • "name": "string",
  • "objectType": "string",
  • "description": "string",
  • "mappings": [
    ],
  • "headers": [
    ],
  • "rowIdHeader": "string",
  • "delimiter": "string",
  • "hasHeaders": true,
  • "fileType": "csv",
  • "jobType": "Import",
  • "isCustomObject": true,
  • "customObjectNamespace": "string"
}
Response samples
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174001",
  • "status": "Created"
}