Back to MarketoImport Custom Objects
Imports a file containing data records into the target instance. Required Permissions: Read-Write Custom Object
Input
type: object
properties:
parameters:
type: object
properties:
apiName:
type: string
description: API Name of the custom object for the import batch job.
format:
type: string
enum:
- csv
- tsv
- ssv
description: Import file format.
required:
- apiName
- format
title: Parameters
data:
required:
- file
properties:
file:
type: string
description: File containing the data records to import.
format: binary
type: object
title: Data
Output
required:
- errors
- requestId
- result
- success
- warnings
type: object
properties:
errors:
type: array
description: Array of errors that occurred if the request was unsuccessful
items:
required:
- code
- message
type: object
properties:
code:
type: string
description: >-
Error code of the error. See full list of error codes <a
href="https://developers.marketo.com/rest-api/error-codes/">here</a>
message:
type: string
description: Message describing the cause of the error
moreResult:
type: boolean
description: Boolean indicating if there are more results in subsequent pages
example: false
nextPageToken:
type: string
description: Paging token given if the result set exceeded the allowed batch size
requestId:
type: string
description: Id of the request made
result:
type: array
description: Array of results for individual records in the operation, may be empty
items:
required:
- batchId
- objectApiName
- operation
- status
type: object
description: Response containing import status information
properties:
batchId:
type: integer
description: Unique integer id of the import batch
format: int32
importTime:
type: string
description: Time spent on the batch
message:
type: string
description: Status message of the batch
numOfObjectsProcessed:
type: integer
description: Number of rows processed so far
format: int32
numOfRowsFailed:
type: integer
description: Number of rows failed so far
format: int32
numOfRowsWithWarning:
type: integer
description: Number of rows with a warning so far
format: int32
objectApiName:
type: string
description: Object API Name
operation:
type: string
description: Bulk operation type. Can be import or export
status:
type: string
description: Status of the batch
success:
type: boolean
description: Whether the request succeeded
example: false
warnings:
type: array
description: Array of warnings given for the operation
items:
required:
- code
- message
type: object
properties:
code:
type: integer
description: Integer code of the warning
format: int32
message:
type: string
description: Message describing the warning