POST /data/v1/async/dataextensions/{id}/rows

Overview

Asynchronously insert data into an identified data extension by id or key, where id is the unique identifier of the data extension and key is the external key (customer key) of the data extension.

URL Parameters

NameTypeDescription
idguidRequiredUnique identifier of the data extension. Required if not using a key.
keystringRequiredExternal customer key of the data extension. Required if not using an ID. Prepend the parameter with key:. For example, /dataextensions/key:{key}/rows.

JSON Parameters

NameTypeDescription
itemsarrayRequiredAn array of objects, where each object represents a row of data in the target data extension. Each object is expected to contain name-value pairs matching the column name and value of the target.

Usage

Example Request

The request body consists of items, which is an array of json objects. Each object is expected to be a name-value pair that corresponds to the columns of the destination data extension. In this example, this data extension must have the fields FirstName, LastName and ZipCode. Partial payloads are valid if they include all required fields.

Example Success Response (202 Accepted)

A successfully queued request returns the RequestId. Use this RequestId in subsequent operations to determine the status of the asynchronous call and overall results of the persist operation.

Example Error Response

This error response shows when the custom object cannot be found before the request gets queued. Any errors that occur during the processing of the request by the business service are recorded with the results and are retrievable using the /data/v1/async/{requestId}/results?includeDetail=true resource.