Submit import data — Guide

First-request guide for Submit import data.

API GUIDE

Submit import data

Submit import data

PUT/job/{id}/dataJSONAuthentication required

Overview

This endpoint is used to submit the data file to an existing import job identified by the path parameter {id}. Submitting the data file triggers the asynchronous processing of the data. You can monitor the progress and final status of the data processing using the dedicated job status endpoint. Note: There is currently no limit to the number of rows you can upload per Submit request, however, files are limited to **5GB**.

Call the endpoint

Send a PUT request to /job/{id}/data with the required authentication and parameters.

Build the request body

Use the JSON shape below and replace example values with your data.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

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

STEP 1

Make a request

REQUEST
curl --request PUT \
  --url https://uapi.demandbase.com/import/v1/job/1/data?listAction=replace \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Content-Type: application/octet-stream" \
  --data-binary @- <<'DATA'
example
DATA
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "id": 67849,
  "dataImportName": "EMEA accounts import",
  "entityType": "Account",
  "state": "processing",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T17:12:29Z"
}

Request anatomy

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

Parameters

NameLocationTypeRequiredDescription
listActionquerystringOptionalThe listAction query parameter specifies how the imported data affects the membership of the account list associated with this job ID. Allowed Value Descriptio…
idpathinteger (int64)Required

Request body

No fields are defined for this payload.

Response anatomy

The endpoint returns 200 for the documented success case. Returns the status of the job after successfull upload.

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

Rules

  • Use PUT with the path /job/{id}/data.
  • Required inputs: id.
  • Authenticate every request with a valid Demandbase access token.
  • Send the request body as application/json.

Filters

The published schema exposes the following endpoint inputs. Use the location column to place each value correctly.

NameLocationTypeRequiredDescription
listActionquerystringOptionalThe listAction query parameter specifies how the imported data affects the membership of the account list associated with this job ID. Allowed Value Descriptio…
idpathinteger (int64)Required

Errors

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

StatusMeaning
400Bad Request Error
401Returned if the authentication credentials are missing or invalid.
403Returned if the authenticated user lacks the "Import Data" permission
404Returned if the referenced job is not found
500Internal Server Error

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to import-job

Back to top