Text Place – SignatureAPI Docs

A text place inserts a static, read-only text value at a specific location in a document. It does not require any action from a recipient. The value is set when the envelope is created and cannot be changed by recipients.

Text places are useful for pre-filling information such as company names, reference numbers, or contract dates before the signing process begins.

Use text places with fixed positions to fill in PDF form fields before the first recipient signs.

You can position text places using either placeholders or fixed positions.

Attributes

type

enum

required

Specifies the type of place.

For a text place, the value must be text.

key

string

required

A unique identifier for this place within the document. Use this key to match the place to its position, either through a [[place_key]] placeholder in the document or an entry in fixed_positions.

Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.

value

string

required

The text content to display on the document. This is a static value set when the envelope is created and cannot be changed by the recipient.

Maximum length is 1000 characters.

font_size

number

The font size in points.

Must be between 1 and 144. The default is 12.

font_color

string

The font color for this text place. Must be a six-digit hex color code with a leading #. Defaults to #000000 (black).

Examples

"documents": [
  {
    //...
    "places": [
      {
        "key": "company_name",
        "type": "text",
        "value": "Lorem Ipsum Ltd",
        "font_size": 12,
        "font_color": "#000000"
      }
    ]
    //...
  }
]