Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Documents - Entry Pads

Update an entry pad

This operation is only valid when the eSignature package is in the DRAFT or LIVE_EDITING status.

put/e-signature-packages/{eSignaturePackageId}/documents/{documentId}/entry-pads/{id}

Request body

signerIdstring

Id of the signer

type'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email'
leftnumber

Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

topnumber

Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

heightnumber

Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

widthnumber

Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

pageIndexnumber

Page index whereby the entry pad is contained in the document.

isOptionalboolean

Set to true if the entry pad is optional.

{"stackTrail":"components:schemas:AnyValue","oasType":"schema","type":"unknown"}

Response

Returns the object if successfully updated. Returns an error if the update parameters are invalid.

idstring
signerIdstring required

Id of the signer

type'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email' required
leftnumber required

Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

topnumber required

Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

heightnumber required

Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

widthnumber required

Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

pageIndexnumber required

Page index whereby the entry pad is contained in the document.

isOptionalboolean

Set to true if the entry pad is optional.

{"stackTrail":"components:schemas:AnyValue","oasType":"schema","type":"unknown"}