Bulk provides an option to upload a large number of resources, such as contacts, to a service provider all at once. You can use bulk to download a csv or json file from a large number of records or upload a csv or json file to add multiple records. See Using Bulk for more information on managing bulk.
Custom Objects
The Eloqua API allows for the creation of Custom Objects that contain Custom Fields. These Custom Objects require special consideration when attempting to use them in a bulk upload. Since the Eloqua native bulk will always perform an upsert on a POST request, a "identifierFieldName" must be provided in the request metadata in order to indicate the unique field to be used for the upsert. For example, if inside of your upload data (JSON/CSV), there is a record with the identifier field value, then it will update that record with new values for the specified fields. If there is no record with the identifier field value, then it will create the new record. This is how the Eloqua bulk API combines an update and upload into an upsert.
It is essential to pass an "identifierFieldName" as the field ID and not the field name, for example {"identifierFieldName":"101"}, where "101" refers to the unique field in the custom object. Failure to provide the "identifierFieldName" in your metadata or providing a field ID that does not match your custom object will result in an error that reads "Unable to retrieve vendor headers from provided file. Please check the file headers or file format". When you see this error please check the field IDs on the Custom Object you are trying to upload to with a GET /{custom-object-name} call.
| Bulk Information | Details |
|---|---|
| Bulk Type | Native API provider bulk. API provider's documentation. |
| Upsert Support | Yes, Upsert only |
| Field Selection Support | No. To limit the fields returned by the query, you must use a transformation. See Define Common Resources and Transformations. For example, you can use only select * for this connector. |
| Order By Support | No |
Hash Verification
If you configured the Callback Notification Signature Key (event.notification.signature.key) when you authenticated a connector instance, the bulk APIs will use the signature key to provide hash verification in the header of bulk jobs. For more information, see Hash Verification.
