Customer Data Platform Developer Guide

Customer Data Platform Developer Guide
Connect Data
Ingest Data
Load Data into Customer Data Platform
Get Started with Ingestion API
Streaming Ingestion
Bulk Ingestion
Create a Job
Upload Job Data
Close or Abort a Job
Delete a Job
Get Job Info
Get All Jobs
Create an Amazon S3 Data Stream
Rotation of S3 Credentials with Metadata API
Model Data
Extract Data
PDF

Bulk Ingestion

With the Customer Data Platform Bulk Ingestion API, you can upsert or delete large data sets. Prepare a CSV file representation of the data you want to upload, create a job, upload job data, and let Salesforce take care of the rest.

Bulk Jobs and Operations

The Bulk Ingestion API upserts or deletes data in the Customer Data Platform using jobs. A bulk job typically goes through following stages:
  • Create a job to specify the object type of the data being processed and the operation that’s performed on the data. The operations supported are upserting bulk data or deleting bulk data.
  • After the job is created upload data in CSV format to the job.
  • To signal the data is ready to be processed, close the job. You can choose to abort the job if necessary.
  • Monitor the progress of the job and act on any failed records.
  • Delete a job.

Prepare CSV Files

Lists the field names for the object that you're processing in the first row in the CSV file. Each subsequent row corresponds to a record in your Customer Data Platform data lake. All the records in a CSV file must be for the same object. You specify this object when you first create the job.
  • Include all required fields when you create a record.
  • Each field-name header in the file must be the same as the Datasource Object's field names. Results only include columns that are a match.
  • Updating records works as a full replace. Patch semantics aren’t supported.
  • Files must be in UTF-8 format. Upload data must not exceed 150 MB.
  • CSV files are expected to be formatted according to RFC 4180, Common Format, and MIME Type for CSV Files.
  • Only supports comma field delimiters.
  • Empty field values are set to null.

Example

1id,contact_name,created_date,tax_exempt,ship_address,total,tax_rate,modified_date
2f19cae7e-5cdb-41ce-92ba-539afea04f9d,Jadyn Kozey,2021-07-22T08:57:08.118Z,false,9818 Walter Course Apt. 811,77506,84,2021-07-05T09:31:44.457Z
348c8b6a6-8179-4a15-ba19-ec5c8206ce28,Kristina Jakubowski,2021-07-08T22:57:02.008Z,false,245 Schowalter Port Suite 245,16986,61,2021-07-03T06:20:52.886Z
456e005af-cc6c-4f9c-b628-ae6cbbc909cc,Aletha Wilkinson,2021-07-21T04:01:29.838Z,true,7494 Hudson Ports Apt. 123,23907,99,2021-07-18T23:21:43.240Z