Import Custom Objects

POST /bulk/v1/customobjects/{apiName}/import.json

Imports a file containing data records into the target instance.

Operation ID: importCustomObjectUsingPOST
Permissions: Read-Write Custom Object
Request format: multipart/form-data
Returns: ResponseOfImportCustomObjectResponse

Parameters

Path 1

apiName string required

API Name of the custom object for the import batch job.

Query 1

format string required

Import file format.

Values csv tsv ssv

Form 1

file file required

File containing the data records to import.

Responses

200 OK ResponseOfImportCustomObjectResponse

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of ImportCustomObjectResponse required

Array of results for individual records in the operation, may be empty

Model ImportCustomObjectResponse

batchId integer (int32) required

Unique integer id of the import batch

importTime string

Time spent on the batch

message string

Status message of the batch

numOfObjectsProcessed integer (int32)

Number of rows processed so far

numOfRowsFailed integer (int32)

Number of rows failed so far

numOfRowsWithWarning integer (int32)

Number of rows with a warning so far

objectApiName string required

Object API Name

operation string required

Bulk operation type. Can be import or export

status string required

Status of the batch

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "batchId": 123,
      "importTime": "string",
      "message": "string",
      "numOfObjectsProcessed": 123,
      "numOfRowsFailed": 123,
      "numOfRowsWithWarning": 123,
      "objectApiName": "Example name",
      "operation": "string",
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.