Skip to content
Subnoto Logo Subnoto Documentation

create-from-file

POST
/public/envelope/create-from-file

Create an envelope and the first document placeholder with a file upload. Accepts multipart/form-data with a PDF, Word (DOCX/DOC), ODT, or RTF document file (max 50 MB). DOCX, ODT, and RTF files are converted to PDF. The file is processed and uploaded directly.

Request Body required

Section titled “Request Body required ”
object
workspaceUuid
required

The UUID of the workspace to create the envelope in.

string
>= 36 characters <= 36 characters
envelopeTitle
required

The title of the envelope being created.

string
<= 255 characters
file
required

The file to upload (PDF, Word, ODT, or RTF document, max 50MB).

detectSmartAnchors

Enable Smart Anchor detection. Set to ‘true’ to detect and process Smart Anchors in the PDF. Defaults to false.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
envelopeUuid
required

The unique identifier of the created envelope.

string
documentUuid
required

The unique identifier of the first document.

string

400

Section titled “400 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: WORKSPACE_NOT_FOUND INVALID_FILE_DATA FILE_SIZE_EXCEEDED INVALID_PDF INVALID_REQUEST DOCUMENT_INVALID DOCUMENT_CONVERSION_UNAVAILABLE DOCUMENT_CONVERSION_FAILED INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

401

Section titled “401 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

403

Section titled “403 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string

500

Section titled “500 ”

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string