Sign in
Custom Object Jobs

Cancel a custom object bulk job

Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is accepted or pending.

patch/objects/jobs/{id}/cancel

Path parameters

idstring uuid required

The ID of the custom object bulk job that you want to cancel.

Headers

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring 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.

Response

OK

CreatedByIdstring uuid

The ID of the user who creates the job.

CreatedDatestring date-time

The time when the bulk job is created.

Idstring uuid

The custom object bulk job ID.

UpdatedByIdstring uuid

The ID of the user who updates the job.

UpdatedDatestring date-time

The time when the bulk job is updated.

namespace'default' | 'com_zuora'

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
objectstring

The object to that the bulk operation performs on.

operation'delete' | 'create' | 'update'

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.

processingTimeinteger

The amount of time elapsed, in milliseconds, from the submission to the completion of the bulk job.

recordsProcessedinteger

The number of object records processed by the bulk job.

status'accepted' | 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled'

The status of the bulk job:

  • accepted - The job has been accepted and is ready to process.
  • pending - The job is waiting for your input. You can use Upload a file for a custom object bulk job to upload a file so that the job can start creating records.
  • in_progress - The job is processing.
  • completed - The job has completed.
  • failed - The job was unable to complete. You can use List all errors for a custom object bulk job to list the errors.
  • cancelled - The job was cancelled by the server.

Example response

{
  "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": {
    "code": 71012560,
    "message": "Service limit reached, please retry later."
  },
  "namespace": "default",
  "object": "passenger",
  "operation": "delete",
  "processingTime": 1882,
  "recordsProcessed": 500,
  "status": "failed"
}

Changes