---
title: "Submit a data labeling job"
method: POST
path: "/v1/multi-organizations/data-labeling-job"
tags: ["Data Labeling"]
---

# Submit a data labeling job

`POST /v1/multi-organizations/data-labeling-job`

Submits a data labeling job.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Track-Id` string
- `Zuora-Version` string

## Request body

- SubmitDataLabelingJobRequest
  - `ids` string[] — The IDs of the objects to be labeled, only required if the `queryType` is `ById`. There is a 4MB limit of the JSON payload, so in case of a large number of IDs, please make sure the payload is less than 4MB.
  - `objectType` string, required — The object type of the data labeling job. Currently, the following objects are supported: * `User` * `Account` All the associated transaction objects of the account being labeled will automatically inherit the org label of the account. * `Product` You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object. You can get all the unlabeled accounts by running a Data Source export job, with the following query: ``` sql SELECT Id, Name FROM Account WHERE Organization.Id IS NULL ``` All the ProductRatePlanS of the product will be automatically labeled with the same `orgs`. When labeling products, you can omit the `orgs` parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those `orgs`, aka, the `derived orgs`. You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the `derived orgs`. * `BillRun` You don't need to specify the `orgs` parameter, we will label the `BillRun` with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain `orgs` to operate separately by `orgs`. * `PaymentRun` Same as BillRun. * `ForecastRun`
  - `orgIds` string[] — The IDs of the organizations that the data labeling job will associate with the data to be labeled. Either the `orgIds` or `orgs` field is required. For `Account` object, one and only one org Id is required. For configuration objects, `null` and `[]` are treated differently, use `null` to unlabel the object, `[]` to label it with all orgs.
  - `orgs` string[] — The names of the organizations that the data labeling job will associate with the data to be labeled. Either the `orgIds` or `orgs` field is required. For `Account` object, one and only one org name is required. For configuration objects, `null` and `[]` are treated differently, use `null` to unlabel the object, `[]` to label it with all orgs.
  - `query` string — The query that the data labeling job will run to fetch the data to be labeled, only required if the `queryType` is `ByZoql`.
  - `queryType` 'ByZoql' | 'ById', required — Specifies the type of query that the data labeling job will run to fetch the data to be labeled. * `ByZoql` - The data labeling job will run a ZOQL query which is specified in the `query` field to fetch the data to be labeled. * `ById` - The data labeling job will fetch the data to be labeled by the IDs specified in the `ids` field.

## Response `200`

OK

- SubmitDataLabelingJobResponse
  - `jobId` string, uuid — Identifier of the data labeling job.
  - `jobStatus` 'Accepted' | 'Dispatched' | 'Completed' — Status of the data labeling job. * `Accepted` - The data labeling job has been accepted by the system. * `Dispatched` - The data labeling job is dispatched to the data labeling service. * `Completed` - The data labeling job has completed. Please note that `Completed` simply means the data labeling job has completed, but it does not mean the data labeling job has labeled all the data. You can check the `progress` field to see how many data have been `labeled`, `failed` or `timeout`.
  - `success` boolean — Indicates whether the job was submitted successfully.

## Other responses

- `400` — Bad Request

---

[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)