patch https://api.talkdeskapp.com/bulk-imports/users/
Scope
bulk-imports:write
Body Request - Example
{
"status": "CANCELED"
}
Body Response - Schema
200 OK (import detail)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | the import unique identifier | no |
| filename | string | the name of the file that was submitted | no |
| total_records | integer | the total number of records to process | no |
| failed_records | integer | the number of records that failed to import | no |
| completed_records | integer | the number of records imported successfully imported | no |
| updated_by | string | the ID of the user/system who updated the import | no |
| updated_at | string | the date when the import was updated | no |
| canceled_by | string or null | the ID of the user/system who canceled the import | no |
| canceled_at | string or null | the date when the import was canceled | no |
| status | string | The status of the import. Allowed values: QUEUED, IN_PROGRESS CANCELED, FAILED, COMPLETED, COMPLETED_WITH_ERRORS | no |
| type | string | The import type. Allowed values: CREATE_USERS, UPDATE_USERS, DELETE_USERS | yes |
| created_by | string | the ID of the user who submitted the import | no |
| created_at | string | the date when the import was submitted | no |
| _links | object | "_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 |
401 (missing authorization header), 403 (invalid authorization), 404 (import not found), 406 (accept format MIME type unsupported)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[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.