Skip to content
Subnoto Logo Subnoto Documentation

update

POST
/public/envelope/update

Update an envelope by UUID.

Request Body required

Section titled “Request Body required ”
object
workspaceUuid
required

The UUID of the workspace to get the envelope from.

string
>= 36 characters <= 36 characters
envelopeUuid
required

The UUID of the envelope to get.

string
>= 36 characters <= 36 characters
update
required
object
title

The new title of the envelope.

string
<= 255 characters
documents
Array<object>
object
uuid
required

The unique identifier of the document to update.

string
>= 36 characters <= 36 characters
title

The new title of the document.

string
<= 255 characters
initialsOnAllPages

Whether the initials are on all pages.

boolean
tags

The names of the tags to add to the envelope.

Array<string>
0
signatureOrder

Whether signature order is enabled for this envelope.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
updateDate
required

The date and time the envelope was last updated (unix timestamp).

number

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 DOCUMENT_NOT_FOUND ENVELOPE_NOT_IN_DRAFT 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