Overview

Create a new job to perform a Data Import. This is prerequisite before posting a file with records to be imported.

Quickstart

Follow these two steps to make a request and recognize a successful response.

curl --request POST \
  --url https://uapi.demandbase.com/import/v1/job \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"dataImportName":"example","entityType":"example","source":"example","activityTypeId":1}'

{
  "id": 67849,
  "dataImportName": "EMEA accounts import",
  "entityType": "Account",
  "state": "new",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

This endpoint does not define additional parameters.

Request body

No fields are defined for this payload.

Response anatomy

The endpoint returns 200 for the documented success case. Returns a JSON object of the newly-created job. The Job ID will be used to upload data and to check on job status.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

• Use POST with the path /job.
• Required inputs: No parameters are marked required in the published schema..
• Authenticate every request with a valid Demandbase access token.
• Send the request body as application/json.

Filters

This endpoint has no additional filters or parameters beyond its authentication requirements.

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

Next steps

Back to top