Skip to main content
A recipient name place inserts the name of the recipient identified by recipient_key at a specific location in the document. The value is inserted automatically and does not require any action from the recipient. You can position recipient name places using either placeholders or fixed positions.

​
Font Size

Use font_size to control the size of the inserted text in points (1/72 inch). Must be between 1 and 144. Defaults to 12.

​
Attributes

​
type
enum
required
Specifies the type of place.For this kind of place, the value must be recipient_name.
​
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.
​
recipient_key
string
required
The key of the recipient assigned to this place. Must match one of the key values in the envelope’s recipients array.
​
font_size
number
The font size in . Must be between 1 and 144. Defaults to 12.

​
Examples

"documents": [
  {
    //...
    "places": [
      {
        "key": "client_name",
        "type": "recipient_name",
        "recipient_key": "client"
      }
    ]
    //...
  }
]