/autoimport/upload
This action uploads an import file for it be processed by an auto import.
To see if an auto import supports this API action, look at the
api_capabilities field returned for the auto import in the response
of the /autoimport/list API action.
Request
| Field | Description | Type | Required |
|---|---|---|---|
autoimport_id | Unique identifier for an auto import | number | Yes |
name | File name of the import file | string | Yes |
content | File content encoded as a base64 string | string | Yes |
Example:
{
"autoimport_id": 80,
"name": "F9884729",
"content": "SERSMDAxOTgtMTE5NDY4NiAgIDIyLTIxOTU5OTYgICA5NTQtMDAtMDAwMCAgMTAwMTIyICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCklOUzAxMDAxODAyMzA2OTkzOCAgICAgWkFEUVRJIFQgQURBRFkgICAgICAgICAgICAgICAgODA0NSAgTkVQRUFSTCBCUkFOQ0ggTUNTICAgICAgQVBUIDk0NUIgICAgICAgICAgICAgICAgICAgICAgSk9ITlNPTiBDSVRZICAgICAgICAgTlkxMzcxMDQ5MjcgICAgIApJTlMwMjgwMjMwNjk5MzggICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDUzMDcwMiBORSBQRUFSTCBCUkFOQ0ggTUxTICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKSU5TMDM4MDIzMDY5OTM4ICAgICBKT0hOU0VOIENJVFkgICAgICAgICBOWTEzNzkwNDkyNjAxMDI1OTY1OTVIMDAwMDAwMDAwME8gICAgICAgICAgIDI5MDUyMTRJQ04zODI4MjgzICAgIDUyLTA4ODMxMDcgMTcwNzYxNzgyNCAgICAgICAgICAgICAgICAgICAgICAgCklOUzA0ODAyMzA2OTkzOCAgICAgMDAwMDAwMDAwMTkwMDAwMDAwMDAwMDAwMDAwMDAwODAxMTExMjAwMDAwMDA3MjA5OTkgICAgQU9DTi1DTFQgIERMNjAyMDQyMTMwMDMyMUEgVjMzTyBPY3dlbiBNYXN0ZXIgU2VydmljaW5nICAgICAgICAgICAgICAgICAgICAgIApJTlMwNTgwMjMwNjk5MzggICAgIFZFQ0FOVCBBTkQgREFNQUdFRCBPTkxZICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEMgVFhOMzgzICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKVFJMMDAxMjItMjE5NTk5NiAgIDAwMDAwMDAwMDYxMTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDYxMTAwMDAwMDYxMSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCg=="
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"autoimport_id":80,"name":"PHHMSPONE-API-10","content":"SERSMDAxOTgtMTE5NDY4NiAgIDIyLTIxOTU5OTYgICA5NTQtMDAtMDAwMCAgMTAwMTIyICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCklOUzAxMDAxODAyMzA2OTkzOCAgICAgWkFEUVRJIFQgQURBRFkgICAgICAgICAgICAgICAgODA0NSAgTkVQRUFSTCBCUkFOQ0ggTUNTICAgICAgQVBUIDk0NUIgICAgICAgICAgICAgICAgICAgICAgSk9ITlNPTiBDSVRZICAgICAgICAgTlkxMzcxMDQ5MjcgICAgIApJTlMwMjgwMjMwNjk5MzggICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIDUzMDcwMiBORSBQRUFSTCBCUkFOQ0ggTUxTICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKSU5TMDM4MDIzMDY5OTM4ICAgICBKT0hOU0VOIENJVFkgICAgICAgICBOWTEzNzkwNDkyNjAxMDI1OTY1OTVIMDAwMDAwMDAwME8gICAgICAgICAgIDI5MDUyMTRJQ04zODI4MjgzICAgIDUyLTA4ODMxMDcgMTcwNzYxNzgyNCAgICAgICAgICAgICAgICAgICAgICAgCklOUzA0ODAyMzA2OTkzOCAgICAgMDAwMDAwMDAwMTkwMDAwMDAwMDAwMDAwMDAwMDAwODAxMTExMjAwMDAwMDA3MjA5OTkgICAgQU9DTi1DTFQgIERMNjAyMDQyMTMwMDMyMUEgVjMzTyBPY3dlbiBNYXN0ZXIgU2VydmljaW5nICAgICAgICAgICAgICAgICAgICAgIApJTlMwNTgwMjMwNjk5MzggICAgIFZFQ0FOVCBBTkQgREFNQUdFRCBPTkxZICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEMgVFhOMzgzICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKVFJMMDAxMjItMjE5NTk5NiAgIDAwMDAwMDAwMDYxMTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDYxMTAwMDAwMDYxMSAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCg=="}' \
https://ppw.web/svc/autoimport/upload
Response
| Field | Description | Type |
|---|---|---|
message | Upload message | string |
Example successful response:
{"message":"File uploaded successfully and queued for processing"}
Errors
| Error Type | Description | Status Code |
|---|---|---|
access_denied | Access token is invalid or expired | 401 |
scope_invalid | Client app does not have the required OAuth scope | 403 |
autoimport_invalid | autoimport_id is invalid | 400 |
auto_import_inactive | Auto import is not active | 400 |
autoimport_not_found | Auto import was not found | 400 |
name_required | File name is required | 400 |
content_required | File content is required | 400 |
content_invalid | File content is invalid | 400 |
upload_not_supported | File Upload action is not support for the auto import | 400 |
upload_failed | File Upload failed | 500 |
queuing_failed | File queuing for processing failed | 500 |