add-blocks

POST

/public/envelope/add-blocks

• Enclave API server

Add blocks to a document snapshot in an envelope

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace.

string

>= 36 characters <= 36 characters

envelopeUuid

required

The UUID of the envelope.

string

>= 36 characters <= 36 characters

documentUuid

required

The UUID of the document.

string

>= 36 characters <= 36 characters

blocks

required

Array of blocks to add to the document.

Array

>= 1 items

Any of:

object

object

page

required

The page number where the block should be placed.

string

x

required

The x position of the block on the page.

number

y

required

The y position of the block on the page.

number

height

The height of the block.

number

width

The width of the block.

number

recipientEmail

The email of the recipient for templated blocks.

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

type

required

string

Allowed values: text

text

required

The text content of the block.

string

templatedText

The type of templated text.

string

Allowed values: email fullname phone

object

object

page

required

The page number where the block should be placed.

string

x

required

The x position of the block on the page.

number

y

required

The y position of the block on the page.

number

height

The height of the block.

number

width

The width of the block.

number

recipientEmail

The email of the recipient for templated blocks.

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

type

required

string

Allowed values: image

src

required

string

fileType

required

The file type of the image.

string

object

object

page

required

The page number where the block should be placed.

string

x

required

The x position of the block on the page.

number

y

required

The y position of the block on the page.

number

height

The height of the block.

number

width

The width of the block.

number

recipientEmail

The email of the recipient for templated blocks.

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

type

required

string

Allowed values: signature

Responses

200

Default Response

object

snapshotDate

required

The date and time the snapshot was created (unix timestamp).

number

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_RECIPIENT_EMAIL 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