The letter template object

{
  "id": "<string>",
  "created": 123,
  "object": "letter_template",
  "blocks": [
    {
      "type": "heading",
      "content": "<string>"
    }
  ],
  "description": "<string>",
  "merge_fields": [
    "<string>"
  ],
  "name": "<string>",
  "variables": [
    {
      "key": "<string>",
      "label": "<string>"
    }
  ],
  "account": "<string>",
  "deleted": false
}

string

required

Unique identifier for the object.

created

number

required

Time at which the object was created. Measured in seconds since the Unix epoch.

object

enum<string>

required

Available options:

letter_template

address_position

enum<string>

required

Which side of page 1 the recipient address window is printed on.

Available options:

left,

right

blocks

object[]

required

Ordered content blocks that make up the letter body.

Option 1
Option 2
Option 3

Show child attributes

description

string | null

required

An optional description of when to use this template.

merge_fields

string[]

required

Merge fields that can be interpolated in heading and text blocks.

name

string

required

The name of the letter template.

recipient_type

enum<string>

required

Who this template is intended for. any can be used with either customers or owners.

Available options:

any,

customer,

owner

variables

object[]

required

Custom variables that can be passed when creating a letter from this template.

Show child attributes

account

string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted

boolean

default:false

Only returned if the object has been deleted.

Yorlet API

Billing

Checkout

Core

Guardrails

Leads

Leasing

Loyalty

Maintenance

Owners

Payments

Terminal

Test Helpers