Add a place: Text Input

Adds a text input place to a document.

Input

Place Key · string · required

A key that identifies this place within the document.

Recipient Key · string · required

A user-provided key that identifies a recipient within an envelope.

It must be up to 32 alphanumeric, lowercase characters and must start with a letter. For example: buyer, employee, party2 are valid recipient keys.

Document ID · string · required

The ID of the document to which the place will be added.

Hint · string

A tooltip message shown over the input field for the recipient.

Prompt · string

A placeholder message shown inside the input text field during the signing ceremony.

Requirement · string

Specifies whether the recipient must fill this field to complete the signing ceremony.

Possible values are required or optional. The default is required.

Capture As · string

A key that stores the recipient’s input and is included in the envelope captures.

Format · string

Specifies the valid format for user input. Refer to the documentation for allowed values.

Format Message · string

The message displayed when the user’s input does not match the required format.

Page Number · string

The page number to position this place.

Distance From Top · string

The distance (in points) from the top of the page to the bottom of the place.

Distance From Left · string

The distance (in points) from the left of the page to the place.

Extra Properties · string

Extra properties for extensibility.

Output

This action has no output.