Skip to content
DocsToSheets

Upload documents

POST
/api/mailboxes/{mailboxId}/uploads
 
curl --request POST \
  --url https://app.docstosheets.com/api/mailboxes/example/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form Files=@file \
  --form ClientReferenceId=example \
  --form Notes=example \
  --form GroupAsSingleDocument=true \
  --form Enqueue=true

Uploads one or more documents (multipart/form-data) to a mailbox for extraction.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
mailboxId
required
string

Request Body

Section titled “Request Body ”
Media type multipart/form-data
object
Files
Array<string>
ClientReferenceId
string
nullable
Notes
string
nullable
GroupAsSingleDocument
boolean
Enqueue
boolean
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json
object
uploadId
required
string
mailboxId
required
string
status
required
string
results
required
Array<object>
object
fileName
required
string
documentId
required
string
extractionId
string
nullable
status
required
string
extractions
required
Array<object>
object
validationStatus
required
string
Allowed values: valid warning invalid
data
required
object
key
additional properties
warnings
Array<object>
object
fieldName
required
string
message
required
string
correlationId
string
nullable
Example 
{
  "results": [
    {
      "extractions": [
        {
          "validationStatus": "valid"
        }
      ]
    }
  ]
}

400

Section titled “400 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Section titled “401 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

413

Section titled “413 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

422

Section titled “422 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}