Create a New Import

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Note: this endpoint works only with user-level token (Authorization Code) and not account-level (Client Credentials).

Scope

bulk-imports:write

Body Response - Schema

202 (import was successfully enqueued)

ParameterTypeDescriptionRequired
idstringthe import unique identifierno
filenamestringthe name of the file that was submittedno
total_recordsintegerthe total number of records to processno
failed_recordsintegerthe number of records that failed to importno
completed_recordsintegerthe number of records imported successfully importedno
updated_bystringthe ID of the user/system who updated the importno
updated_atstringthe date when the import was updatedno
canceled_bystring or nullthe ID of the user/system who canceled the importno
canceled_atstring or nullthe date when the import was canceledno
statusstringThe status of the import.
Allowed values:
QUEUED, IN_PROGRESS
CANCELED, FAILED,
COMPLETED,
COMPLETED_WITH_ERRORS
no
typestringThe import type. Allowed values:
CREATE_USERS, UPDATE_USERS, DELETE_USERS
yes
created_bystringthe ID of the user who submitted the importno
created_atstringthe date when the import was submittedno
_linksobject"_links" subdivides into:

1 - "self" (object) - the URI of the imports list.
1.1 - "href" (object) - the URI value. Example: http://api-docs.talkdesk.org/bulk-imports/users

2 - "records" (object) - the URI of the import records.
2.1 - "href" (object) - the URI value
no

400 (bad request when query parameters contain invalid values), 401 (missing authorization header), 403 (invalid authorization), 406 (accept format MIME type unsupported), 413 (payload too large)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!