--- title: "Create a bulk job" method: POST path: "/bulk-data/bulk-jobs" tags: ["Bulk Data"] --- # Create a bulk job `POST /bulk-data/bulk-jobs` Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel. The response includes the job ID and information needed to upload your data file to S3. ### Next Step: Upload the File to S3 After creating a bulk job, you must upload the data file to Amazon S3 using the information returned in the `uploadFileInfo` object. This includes: - `uploadUrl`: The S3 endpoint to which the file must be uploaded. - `formFields`: Key-value pairs to include in a multipart/form-data POST request. - `jobId`: The ID of the job, used for later submission. You can use the following cURL command to upload the file: ``` curl --request POST \ --url '' \ --header 'Content-Type: multipart/form-data' \ --form 'key=' \ --form 'bucket=' \ --form 'x-amz-algorithm=' \ --form 'x-amz-credential=' \ --form 'x-amz-date=' \ --form 'Policy=' \ --form 'x-amz-signature=' \ --form 'x-amz-security-token=' \ --form 'file=@/path/to/your/file.csv' ``` **Note**: Always use the exact form field keys returned in the `formFields` object of the API response. This is a presigned Amazon S3 POST operation and not a Zuora endpoint. After uploading the file, you must call the "Submit a bulk job for processing" operation endpoint to start processing the job. ## Headers - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Track-Id` string ## Request body - BulkJobRequest - `name` string, required — Name of the job. Max length is 255 characters. - `objectType` 'account' | 'accountingcode' | 'accountingperiod' | 'account-legacy' | 'advanced-accounts-and-contact' | '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' | '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' | 'product' | 'product-charge-definition' | 'product-rate-plan' | 'product-rate-plan-charge' | 'product-rate-plan-charge-tier' | 'product-rate-plan-definition' | 'refund' | 'refund-legacy' | 'revenue-accounting-code' | 'subscription' | 'subscription-add-rate-plan' | 'subscription-change-rate-plan' | 'subscription-remove-rate-plan' | 'subscription-update-rate-plan' | 'taxation-item' | 'unitofmeasure' | 'usage', required — The type of the object on which the bulk job is created. **Note**: - To import or delete an account, use `account`. - To update an account, use `advanced-accounts-and-contact`. - To update an account's status, use `account-legacy` as the `objectType`. - `description` string — Short description of the job. Max length is 255 characters - `mappings` object[] — List of mappings. Each mapping maps a source field to a target field in the object. If the field is an array, the type and arrayType must be specified. - `source` string, required — Source field name - `target` string, required — Target field name. **Note**: The `target` field must not contain spaces, dots (`.`), underscores (`_`), or asterisks (`*`). - `type` 'array' | 'string' | 'number' | 'boolean' — Field type - `arrayType` 'string' | 'number' | 'boolean' — Type of objects in the array if the field is an array type - `headers` string[] — 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` 'csv' | 'jsonl' — 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 - `jobType` 'Import' | 'Delete' | 'Update' | 'Cancel' — Type of the bulk job being created. Default is IMPORT - `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'. - `dataSourceType` 'UserUpload' | 'Salesforce' | 'Chargebee' | 'Stripe' — The data source type of the job - `systemType` 'BILLING' — The system type for the job ## Response `200` Job creation successful - CreateResponse - `id` string, uuid — Unique identifier for the job - `uploadUrl` string — URL to upload the file. This is the URL to which the file should be uploaded using a PUT request. - `uploadRequest` object - `uri` string, uri — URL to which the file must be uploaded. - `fields` object — Form fields required to complete the S3 file upload. - `status` 'Created' | 'Submitted' | 'In Progress' | 'Aborting' | 'Completed' | 'Failed' | 'Aborted' | 'Cancelled' | 'Downloading' — Status of the job - `jobType` 'Import' | 'Delete' | 'Update' | 'Cancel' — Type of the job --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)