add-attachment

POST

/public/envelope/add-attachment

• Enclave API server

Add a document attachment to an existing envelope. Accepts multipart/form-data with a PDF or Word document file.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace containing the envelope.

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 or Word document, max 11MB).

Responses

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

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

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

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

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

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