Skip to content
Subnoto Logo Subnoto Documentation

add-attachment

POST
/public/envelope/add-attachment

Add a document attachment to an existing envelope. Accepts multipart/form-data with a PDF, Word (DOCX/DOC), ODT, or RTF document file.

Request Body required

Section titled “Request Body required ”
object
workspaceUuid

Optional. When omitted, the team’s default workspace is used.

string
>= 36 characters <= 36 characters
envelopeUuid
required

The UUID of the envelope to attach the document to.

string
>= 36 characters <= 36 characters
documentTitle
required

The title of the document attachment.

string
<= 255 characters
file
required

The file to attach (PDF, Word, ODT, or RTF document, max 11MB).

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
documentUuid
required

The unique identifier of the created document.

string
revisionEncryptionKey
required

The key in base64 for the document revision.

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 ENVELOPE_NOT_FOUND ENVELOPE_NOT_IN_DRAFT DOCUMENT_INVALID FILE_SIZE_EXCEEDED 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
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

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 TUNNEL_SESSION_NOT_FOUND 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
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

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
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

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
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

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