SOsoldo
Documents

Upload Document

Changed on

Endpoint to upload a Document.The first step is to get a temporary URL where to upload the file.

post/business/v2/documents/upload

Request

Request body application/x-www-form-urlencoded

content_typestring required

The MIME type of the Document.

file_extensionstring required

The file extension of the Document.

Example request

{
  "content_type": "application/pdf",
  "file_extension": "pdf"
}

Response

The returned resource is a single UploadUrlDocument.

uploaded_bystring

The User or system that uploaded the file of the Document

operation_type'UPLOAD_URL' | 'UPLOAD_COMPLETED'
content_typestring

The MIME type of the Document.

attachment_namestring

Attachment name of the Document

pre_signed_urlstring

Pre-signed URL of the Document

Example response

{
  "uploaded_by": "USER",
  "content_type": "application/pdf",
  "attachment_name": "1779089463912.pdf",
  "pre_signed_url": "https://example.com/upload-url"
}

Changes