Upload Documents

  1. API Docs
  2. Documents
  3. Upload Documents

You can use this API method to upload a document file containing multiple documents.

You POST the file as you would a standard HTTP POST file upload, as if it were posted via an html form with an enctype of multipart/form-data and a FILE input type field.

Files are in a CSV format and must contain headers that match our document field's keys as the first line.

Parameters
Parameter Type Required Default Description
csv File Yes N/A The csv file to upload POSTED
zip File Yes N/A The zip file to upload POSTED
Sample Response
{
    "status": 1,
    "total_document_count": 5,
    "document": [
        {
            "id": 4608,
            "client_id": "1100",
            "user_id": "1935",
            "confirmed": 1,
            "file_id": 339,
            "postage_id": 1,
            "address": "417 hall st, warren oh 44483417 Hall st, Warren OH 44483",
            "return_address": "100 Fulton Ct",
            "type_id": 1,
            "recipient": "BTest C1_CS_1P_P1",
            "cover": "1",
            "color": "1",
            "duplex": "0",
            "pages": 1,
            "file_name": "1Page_Color.pdf"
        },
        {
            "id": 4609,
            "client_id": "1100",
            "user_id": "1935",
            "confirmed": 1,
            "file_id": 339,
            "postage_id": 1,
            "address": "417 hall st, warren oh 44483417 Hall st, Warren OH 44483",
            "return_address": "100 Fulton Ct",
            "type_id": 1,
            "recipient": "BTest C1_BD_2P_P2",
            "cover": "1",
            "color": "0",
            "duplex": "1",
            "pages": 2,
            "file_name": "2Page_BW.pdf"
        },
        {
            "id": 4610,
            "client_id": "1100",
            "user_id": "1935",
            "confirmed": 1,
            "file_id": 339,
            "postage_id": 1,
            "address": "100 Fulton Ct100 Fulton Ct, Paducah KY 42001",
            "return_address": "100 Fulton Ct",
            "type_id": 1,
            "recipient": "BTest C1_CS_3P_P5",
            "cover": "1",
            "color": "1",
            "duplex": "0",
            "pages": 3,
            "file_name": "3Page_Color.pdf"
        },
        {
            "id": 4611,
            "client_id": "1100",
            "user_id": "1935",
            "confirmed": 1,
            "file_id": 339,
            "postage_id": 1,
            "address": "100 Fulton Ct Paducah, FAYETTEVILLE WV 25840-1333",
            "return_address": "100 Fulton Ct",
            "type_id": 1,
            "recipient": "BTest C0_BD_4P_P1",
            "cover": "0",
            "color": "0",
            "duplex": 1,
            "pages": 4,
            "file_name": "4Page_BW.pdf"
        },
        {
            "id": 4612,
            "client_id": "1100",
            "user_id": "1935",
            "confirmed": 1,
            "file_id": 339,
            "postage_id": 1,
            "address": "100 Purity RdSuite 3, Pittsburgh PA 15235",
            "return_address": "100 Fulton Ct",
            "type_id": 1,
            "recipient": "BTest C0_BD_4P_P2",
            "cover": "1",
            "color": "1",
            "duplex": 1,
            "pages": 7,
            "file_name": "7Page_Color.pdf"
        }
    ],
    "files": {
        "id": 339,
        "client_id": "1100",
        "user_id": "1935",
        "tpl_id": null,
        "errors": null,
        "processed": 1,
        "confirmed": 1,
        "confirmed_ts": "2024-02-05 21:05:00",
        "deleted": 0,
        "file_name": "MixedDocTestFAILURE-2.csv"
    },
    "errors": [],
    "error_message": null
}