Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Bulk Import API

Updates one import

Updates one import

patch/bulk-imports/users/{import_id}

Path parameters

import_idstring uuid required

Request body

status'CANCELED' required

The status to be altered

Response

The updated import

idstring

the import unique identifier

filenamestring

The name of the file that was submitted

total_recordsinteger

The total number of records to proccess

failed_recordsinteger

The number of records that failed to import

completed_recordsinteger

The number of records imported successfully imported

status'QUEUED' | 'IN_PROGRESS' | 'CANCELED' | 'FAILED' | 'SUCCESSFUL' | 'COMPLETED_WITH_ERRORS'

The status of the import

type'CREATE_USERS' | 'UPDATE_USERS' | 'DELETE_USERS' | 'EXPORT_USERS'

The import type

created_bystring

The id of the user who submitted the import

created_atstring date-time

The date when the import was submitted

updated_bystring

The id of the user/system who updated the import

updated_atstring date-time

The date when the import was updated

canceled_bystring

The id of the user/system who canceled the import

canceled_atstring date-time

The date when the import was canceled