Create a document within a tenant

Provision a document within a tenant by providing an inbox ID

Query Parameters

• inbox_id string required

  Paperbox inbox ID

• 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, image/heic, image/heif, application/pdf, message/rfc822, application/eml, text/html, text/plain, application/octet-stream, /octet-stream, image/gif, 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

• provider_document_id string required

  Custom document ID, set by the user

• doc_type_id string

  Document type ID (Can only be used if an inbox_id is provided)

• doc_subtype_id string

  Document subtype ID (Can only be used if an inbox_id is provided)

• tag_type_id string

  Tag type ID (Can only be used if an inbox_id is provided)

• metadata binary

  Additional document metadata (JSON-formatted)

• name string

  Name of the document

Responses

• 202

---

Payload accepted for processing

Schema

• id string

  Document ID