TAtalkdesk
Bulk Import API

Create a new import

Create a new import

post/bulk-imports/users

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/bulk-imports/users
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: bulk-imports:write

Request body

type'EXPORT_USERS' required

The import type

Response

Import was successfully enqueued

idstring required

the import unique identifier

filenamestring required

The name of the file that was submitted

total_recordsinteger required

The total number of records to proccess

failed_recordsinteger required

The number of records that failed to import

completed_recordsinteger required

The number of records imported successfully imported

updated_bystring

The id of the user/system who updated the import

updated_atstring date-time required

The date when the import was updated

canceled_bystring nullable

The id of the user/system who canceled the import

canceled_atstring date-time nullable

The date when the import was canceled

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

The status of the import

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

The import type

created_bystring required

The id of the user who submitted the import

created_atstring date-time required

The date when the import was submitted

Changes

No recorded changes to this operation across all 2 revisions of this API.