Raw schema
{
"type": "object",
"properties": {
"to": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"description": "Unit/suite/apt, e.g. 'Suite 6100'.",
"type": "string"
},
"address_city": {
"type": "string"
},
"address_state": {
"description": "2-letter state/province code for US/CA.",
"type": "string"
},
"address_zip": {
"description": "ZIP / postal code.",
"type": "string"
},
"address_country": {
"description": "2-letter ISO country code. Defaults to US.",
"type": "string"
}
},
"required": [
"address_line1"
],
"description": "Inline address object."
}
],
"description": "Either an existing address id (adr_…) or an inline address object."
},
"from": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"description": "Unit/suite/apt, e.g. 'Suite 6100'.",
"type": "string"
},
"address_city": {
"type": "string"
},
"address_state": {
"description": "2-letter state/province code for US/CA.",
"type": "string"
},
"address_zip": {
"description": "ZIP / postal code.",
"type": "string"
},
"address_country": {
"description": "2-letter ISO country code. Defaults to US.",
"type": "string"
}
},
"required": [
"address_line1"
],
"description": "Inline address object."
}
],
"description": "Return address (id or inline object). Required for letters."
},
"file": {
"type": "string",
"description": "Letter body: HTML string, asset/PDF URL, or template id (tmpl_…)."
},
"color": {
"type": "boolean",
"description": "true = color printing, false = black & white."
},
"double_sided": {
"description": "Print on both sides. Default true.",
"type": "boolean"
},
"address_placement": {
"description": "Where the recipient address is placed.",
"type": "string",
"enum": [
"top_first_page",
"insert_blank_page",
"bottom_first_page_center",
"bottom_first_page"
]
},
"description": {
"description": "Internal label.",
"type": "string"
},
"merge_variables": {
"description": "Key/value data merged into HTML templates.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"send_date": {
"description": "ISO-8601 date/time to schedule the send (future). Cancelable until then.",
"type": "string"
},
"extra_service": {
"description": "Tracked mail (extra cost): certified or certified_return_receipt for U.S. addresses, registered for international ones. Omit for ordinary mail.",
"type": "string",
"enum": [
"certified",
"certified_return_receipt",
"registered"
]
},
"mail_type": {
"description": "USPS mail class. Default usps_first_class. extra_service needs first class.",
"type": "string",
"enum": [
"usps_first_class",
"usps_standard"
]
},
"use_type": {
"description": "Lob mail use type: operational (bills, notices, legal letters) or marketing. Lob requires it unless the account has a default use type (Account Settings).",
"type": "string",
"enum": [
"marketing",
"operational"
]
}
},
"required": [
"to",
"from",
"file",
"color"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}