Skip to main content
Version: v2

Create a document in an inbox

Provision an operational document in an inbox

Path Parameters
  • inbox_id string required

    Paperbox inbox id

Query Parameters
  • key string required
Header Parameters
  • X-PB-Document-Content-Type string

    Possible values: [application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/rtf, application/docx, application/rtf, application/x-rtf, application/vnd.ms-office, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-excel, application/vnd.oasis.opendocument.spreadsheet, application/x-gtar, application/x-tar, application/x-bzip2, application/x-xz, application/x-gzip, application/gzip, application/x-bzip, application/x-7z-compressed, application/x-zip-compressed, image/png, image/jpeg, image/tiff, image/jpg, image/*, image/x-png, image/webp, image/bmp, application/pdf, message/rfc822, application/eml, text/html, text/plain, application/octet-stream, /octet-stream, image/gif, application/vnd.ms-outlook, application/x-msg, text/vcard, text/x-vcard, application/zip, inode/x-empty]

    Optional header to specify the content type of the document. This header overrides the content-type that is passed in the form data.

Request Body required
  • document binary required

    Document payload

  • document_id string required

    Document id

  • document_class string

    Document type id

  • document_subclass string

    Document subtype id

  • tag_type_id string

    Tag type id

  • metadata binary

    Additional metadata in the form of a JSON file.

Responses

Payload accepted for processing