Create a Job

Creating a data stream in Data Cloud is a prerequisite for creating a job. When the job is created it’s ready to accept data for processing via Upload Job Data request.

URI

/api/v1/ingest/jobs

Available since release

Data Cloud v1.0, Salesforce v51.0

Formats

JSON

HTTP methods

POST

Authentication

Authorization: Bearer access_token

Request body

All fields defined in the schema must be present in the request payload. This condition holds regardless of whether the Value Required is set to true or not. If there’s no data available for a certain field on a record, send in a blank value.

Note

1{
2   "object":"my_object",
3   "sourceName":"my_api_connector",
4   "operation":"upsert"
5}

Request parameters

Parameter	Description
object	The object type for the data being processed. Use only a single object type per job.
operation	The processing operation for the job. Valid values are upsert and delete.
sourceName	The name of the Ingestion API connector.

Response body

The JSON response body returns a property called id that corresponds to the job id. The state is set to open, which signals that the job has been created and data can be added to the job. Retain the job id for subsequent steps.

1HTTP/1.1 201 Created
2{
3       "id": "4d5a4477-e27f-4bc1-a219-31e79407eade",
4       "operation": "upsert",
5       "object": "my_object",
6       "sourceName": "my_api_connector",
7       "createdById": "005R0000000sJ1hIAE",
8       "createdDate": "2021-04-05T13:35:31.000Z",
9       "systemModstamp": "2021-04-05T13:35:31.000Z",
10       "state": "Open",
11       "contentType": "CSV",
12       "apiVersion": v1,
13       "contentUrl": "api/v1/ingest/jobs/4d5a4477-e27f-4bc1-a219-31e79407eade/batches"
14}