Skip to content
Subnoto Logo Subnoto Documentation

Delete Recipients Envelope

POST
/public/envelope/delete-recipients
 
curl --request POST \
  --url https://enclave.subnoto.com/public/envelope/delete-recipients \
  --header 'Content-Type: application/json' \
  --data '{ "workspaceUuid": "example", "envelopeUuid": "example", "recipients": [ { "email": "[email protected]" } ] }'

Remove multiple recipients from an envelope

Request Body required

Section titled “Request Body required ”
Media type application/json
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 delete (max 50).

Array<object>
>= 1 items <= 50 items
object
email
required

The recipient’s email address to delete.

string format: email
<= 255 characters /^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
Example generated
{
  "workspaceUuid": "example",
  "envelopeUuid": "example",
  "recipients": [
    {
      "email": "[email protected]"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
Example generated
{}

400

Section titled “400 ”

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: WORKSPACE_NOT_FOUND ENVELOPE_NOT_FOUND RECIPIENT_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
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
Example 
{
  "error": {
    "code": "WORKSPACE_NOT_FOUND"
  }
}

401

Section titled “401 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "AUTHENTICATION_ERROR"
  }
}

403

Section titled “403 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "AUTHORIZATION_ERROR"
  }
}

500

Section titled “500 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "INTERNAL_SERVER_ERROR"
  }
}