Find us at our new Help Center where we've combined our documentation and knowledgebase articles in one easy-to-search location.
We aren't updating the Developer Portal anymore, except for the Element Docs — all updates happen in the Help Center. We're retiring the Developer Portal as you know it in:
Unlike bulk downloads, using the bulk upload requires only a single call. The POST /bulk/{objectName}
uploads a file which will then be processed by the bulk job.
For files that don't have column headers that match the field names in an endpoint, a transformation is required. The transformation provides a mapping from the column headers to field names. See Defining Common Resources & Transformations for more information about transformations.
The Bulk Upload is composed of the following parts:
Elements-Async-Callback-Url
: A webhook to be notified when the job completes. If you configured the Callback Notification Signature Key (event.notification.signature.key
) when you authenticated an element instance, the bulk APIs will use the signature key to provide hash verification in the header of bulk jobs. For more on Cloud Elements Hash Verification, see Event Management: Security{objectName}
: The object that matches the file.metaData
: Any metadata that supports the upload operation.file
: The file to be uploaded, either csv or json.Note: For elements that support upsert identifierFieldName
is passed in the metaData
to designate the field to be used for upserts.