PApandadoc
Document Sections (Bundles)

Document Section Upload Status

Changed on

Receive the upload status of the document and sections by their upload_id.

Requesting document section upload status is useful to ensure a document section upload is in the expected state before calling additional API methods.

In response, you receive an array with sections_uuid. You can receive information about each section using the Document Section Info endpoint.

    "section_uuids": [
        "H8T8CJofGY6JwTsWsPuDEF",
        "8MwLaU4SaZywqLiDk26mDF"
    ]

Available Document Section Upload Statuses

The following is a complete list of all possible document statuses returned:

Document StatusStatus Description
document_sections_upload.UPLOADEDThe document section upload process has just been created. It is in processing and will be in document_sections_upload.PROCESSED state momentarily.
document_sections_upload.PROCESSEDThe document sections upload is processed and the sections are already created in the document. All aspects of the document sections can be edited in this state.
document_sections_upload.ERRORDocument section upload procces has been failed. For more information check error details in the response.
get/public/v1/documents/{document_id}/sections/uploads/{upload_id}

Request

Path parameters

document_idstring required

Document ID.

upload_idstring required

Upload ID.

Response

OK

uuidstring
document_uuidstring
status'document_sections_upload.UPLOADED' | 'document_sections_upload.PROCESSED' | 'document_sections_upload.ERROR'
namestring
sections_uuidsstring[]
date_createdstring
date_modifiedstring

Example response

{
  "uuid": "7kqXgjFejB2toXxjcC5jfZ",
  "document_uuid": "cKbJ7uay3cEGtsKuGPwYGX",
  "status": "document_sections_upload.PROCESSED",
  "name": "API Sample Section from PandaDoc Template",
  "sections_uuids": [
    "cKbJ7uay3cEGtsKuGPwYGX",
    "jzjCfYgKQYm2u9ctwN6io4"
  ],
  "date_created": "2021-10-08T11:06:32.337395Z",
  "date_modified": "2021-10-08T11:06:32.337395Z"
}

Changes