Skip to content
Subnoto Logo Subnoto Documentation

add-recipients

POST
/public/envelope/add-recipients

Add multiple recipients to an envelope

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.

string
>= 36 characters <= 36 characters
recipients
required

List of recipients to add (max 50).

Array
>= 1 items <= 50 items
One of:
object
type
required
string
Allowed values: manual
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
phone

The recipient’s phone number (required for SMS verification).

string
<= 32 characters
language

The language for the recipient (e.g., ‘en’, ‘fr’).

string
Allowed values: en fr es it fi
verificationType

The verification type for the recipient.

string
Allowed values: none sms email

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

object
recipients
required
Array<object>
object
email
required

The recipient’s email address.

string
firstname
required

The recipient’s first name.

string
lastname
required

The recipient’s last name.

string
role
required

The recipient’s role.

string
Allowed values: signer
associatedContact
required

Whether the recipient is associated with a contact.

boolean
status
required

The current status of the recipient.

string
Allowed values: pending approved signed declined canceled
colorVariant
required

The color variant assigned to the recipient.

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 DUPLICATE_RECIPIENT ENVELOPE_NOT_IN_DRAFT CONTACT_NOT_FOUND USER_NOT_FOUND 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

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