Skip to content
Subnoto Logo Subnoto Documentation

create-from-template

POST
/public/envelope/create-from-template

Create a new envelope from a template by copying documents and mapping recipient labels to actual recipients

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
templateUuid
required

The UUID of the template to copy from.

string
>= 36 characters <= 36 characters
recipients
required

Array of recipients with labels to map to template recipient labels.

Array
>= 1 items
Any of:
object
type
required
string
Allowed values: manual
label
required

The label to map to template recipient labels.

string
>= 1 characters <= 255 characters
email
required

The recipient’s email address.

string format: email
<= 128 characters /^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
firstname
required

The recipient’s first name.

string
<= 128 characters
lastname
required

The recipient’s last name.

string
<= 128 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
envelopeUuid
required

The UUID of the created envelope.

string
documentUuids
required

Array of UUIDs of the created documents.

Array<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 TEMPLATE_NOT_FOUND CONTACT_NOT_FOUND USER_NOT_FOUND INVALID_RECIPIENT_LABELS 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 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