Lob MCP by usefulapi is an MCP server published by io.usefulapi, hosted at lob.usefulapi.io. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 18 tools, including lob_verify_us_address, lob_verify_intl_address, lob_us_zip_lookup, lob_us_autocomplete, lob_list_postcards.
Verify US & international addresses and send physical mail (postcards, letters, checks) via Lob.
4,319 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Validate & standardize a US address, returning deliverability, corrected components, and a confidence score. Pass either a single freeform `address` string OR structured `primary_line`/`city`/`state`/`zip_code`. Non-mutating (no mail sent). Lob API: POST /v1/us_verifications.
| Parameter | Type | Description |
|---|---|---|
| city | string | |
| state | string | 2-letter state code, e.g. 'CA'. |
| address | string | Freeform single-line address (alternative to the structured fields). |
| zip_code | string | 5-digit or ZIP+4. |
| primary_line | string | Primary delivery line, e.g. '210 King Street'. |
| secondary_line | string | Secondary line, e.g. 'Suite 6100'. |
{
"name": "lob_verify_us_address",
"title": "Verify a US address",
"description": "Validate & standardize a US address, returning deliverability, corrected components, and a confidence score. Pass either a single freeform `address` string OR structured `primary_line`/`city`/`state`/`zip_code`. Non-mutating (no mail sent). Lob API: POST /v1/us_verifications.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "2-letter state code, e.g. 'CA'."
},
"address": {
"type": "string",
"description": "Freeform single-line address (alternative to the structured fields)."
},
"zip_code": {
"type": "string",
"description": "5-digit or ZIP+4."
},
"primary_line": {
"type": "string",
"description": "Primary delivery line, e.g. '210 King Street'."
},
"secondary_line": {
"type": "string",
"description": "Secondary line, e.g. 'Suite 6100'."
}
}
},
"annotations": {
"title": "Verify a US address",
"readOnlyHint": true
}
}Validate & standardize a non-US address. `country` (2-letter ISO code) is required. Non-mutating (no mail sent). Lob API: POST /v1/intl_verifications.
| Parameter | Type | Description |
|---|---|---|
| city | string | |
| state | string | State / province / region. |
| country * | string | 2-letter ISO country code, e.g. 'GB', 'DE', 'CA'. |
| postal_code | string | |
| primary_line * | string | Primary delivery line. |
| secondary_line | string |
{
"name": "lob_verify_intl_address",
"title": "Verify an international address",
"description": "Validate & standardize a non-US address. `country` (2-letter ISO code) is required. Non-mutating (no mail sent). Lob API: POST /v1/intl_verifications.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"primary_line",
"country"
],
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "State / province / region."
},
"country": {
"type": "string",
"description": "2-letter ISO country code, e.g. 'GB', 'DE', 'CA'."
},
"postal_code": {
"type": "string"
},
"primary_line": {
"type": "string",
"description": "Primary delivery line."
},
"secondary_line": {
"type": "string"
}
}
},
"annotations": {
"title": "Verify an international address",
"readOnlyHint": true
}
}Return the cities and state associated with a US ZIP code. Non-mutating. Lob API: POST /v1/us_zip_lookups.
| Parameter | Type | Description |
|---|---|---|
| zip_code * | string | A 5-digit US ZIP code, e.g. '94107'. |
{
"name": "lob_us_zip_lookup",
"title": "Look up a US ZIP code",
"description": "Return the cities and state associated with a US ZIP code. Non-mutating. Lob API: POST /v1/us_zip_lookups.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"zip_code"
],
"properties": {
"zip_code": {
"type": "string",
"description": "A 5-digit US ZIP code, e.g. '94107'."
}
}
},
"annotations": {
"title": "Look up a US ZIP code",
"readOnlyHint": true
}
}Suggest complete US addresses from a partial primary line — useful for address entry. Non-mutating. Lob API: POST /v1/us_autocompletions.
| Parameter | Type | Description |
|---|---|---|
| city | string | Optional city to narrow suggestions. |
| state | string | Optional 2-letter state to narrow suggestions. |
| zip_code | string | Optional ZIP to narrow suggestions. |
| address_prefix * | string | Partial primary line, e.g. '185 Berr'. |
{
"name": "lob_us_autocomplete",
"title": "Autocomplete a US address",
"description": "Suggest complete US addresses from a partial primary line — useful for address entry. Non-mutating. Lob API: POST /v1/us_autocompletions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"address_prefix"
],
"properties": {
"city": {
"type": "string",
"description": "Optional city to narrow suggestions."
},
"state": {
"type": "string",
"description": "Optional 2-letter state to narrow suggestions."
},
"zip_code": {
"type": "string",
"description": "Optional ZIP to narrow suggestions."
},
"address_prefix": {
"type": "string",
"description": "Partial primary line, e.g. '185 Berr'."
}
}
},
"annotations": {
"title": "Autocomplete a US address",
"readOnlyHint": true
}
}List sent/scheduled postcards, newest first. Lob API: GET /v1/postcards.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_postcards",
"title": "List postcards",
"description": "List sent/scheduled postcards, newest first. Lob API: GET /v1/postcards.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List postcards",
"readOnlyHint": true
}
}Retrieve a single postcard by id, including status, PDF url, and expected delivery. Lob API: GET /v1/postcards/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Postcard id (psc_…). |
{
"name": "lob_get_postcard",
"title": "Get a postcard",
"description": "Retrieve a single postcard by id, including status, PDF url, and expected delivery. Lob API: GET /v1/postcards/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Postcard id (psc_…)."
}
}
},
"annotations": {
"title": "Get a postcard",
"readOnlyHint": true
}
}List sent/scheduled letters, newest first. Lob API: GET /v1/letters.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_letters",
"title": "List letters",
"description": "List sent/scheduled letters, newest first. Lob API: GET /v1/letters.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List letters",
"readOnlyHint": true
}
}Retrieve a single letter by id, including status, PDF url, and tracking. Lob API: GET /v1/letters/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Letter id (ltr_…). |
{
"name": "lob_get_letter",
"title": "Get a letter",
"description": "Retrieve a single letter by id, including status, PDF url, and tracking. Lob API: GET /v1/letters/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Letter id (ltr_…)."
}
}
},
"annotations": {
"title": "Get a letter",
"readOnlyHint": true
}
}List sent/scheduled checks, newest first. Lob API: GET /v1/checks.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_checks",
"title": "List checks",
"description": "List sent/scheduled checks, newest first. Lob API: GET /v1/checks.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List checks",
"readOnlyHint": true
}
}Retrieve a single check by id, including amount, status, and check number. Lob API: GET /v1/checks/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Check id (chk_…). |
{
"name": "lob_get_check",
"title": "Get a check",
"description": "Retrieve a single check by id, including amount, status, and check number. Lob API: GET /v1/checks/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Check id (chk_…)."
}
}
},
"annotations": {
"title": "Get a check",
"readOnlyHint": true
}
}List sent/scheduled self-mailers, newest first. Lob API: GET /v1/self_mailers.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_self_mailers",
"title": "List self-mailers",
"description": "List sent/scheduled self-mailers, newest first. Lob API: GET /v1/self_mailers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List self-mailers",
"readOnlyHint": true
}
}List saved address records, newest first. Lob API: GET /v1/addresses.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_addresses",
"title": "List saved addresses",
"description": "List saved address records, newest first. Lob API: GET /v1/addresses.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List saved addresses",
"readOnlyHint": true
}
}Retrieve a single saved address record by id. Lob API: GET /v1/addresses/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Address id (adr_…). |
{
"name": "lob_get_address",
"title": "Get a saved address",
"description": "Retrieve a single saved address record by id. Lob API: GET /v1/addresses/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Address id (adr_…)."
}
}
},
"annotations": {
"title": "Get a saved address",
"readOnlyHint": true
}
}List saved HTML templates usable as postcard/letter artwork. Lob API: GET /v1/templates.
| Parameter | Type | Description |
|---|---|---|
| after | string | Cursor for the next page (from a previous response's next_url). |
| limit | integer | Max results per page (1–100). Default 10. |
| before | string | Cursor for the previous page (from a previous response's previous_url). |
{
"name": "lob_list_templates",
"title": "List templates",
"description": "List saved HTML templates usable as postcard/letter artwork. Lob API: GET /v1/templates.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"type": "string",
"description": "Cursor for the next page (from a previous response's next_url)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max results per page (1–100). Default 10."
},
"before": {
"type": "string",
"description": "Cursor for the previous page (from a previous response's previous_url)."
}
}
},
"annotations": {
"title": "List templates",
"readOnlyHint": true
}
}Create a reusable saved address record (does NOT send any mail). Returns an address id (adr_…) usable as `to`/`from` in mail tools. Lob API: POST /v1/addresses.
| Parameter | Type | Description |
|---|---|---|
| name | string | Recipient name (required unless `company` is set). |
| company | string | |
| address_zip | string | ZIP / postal code. |
| description | string | Internal label for this address. |
| address_city | string | |
| address_line1 * | string | Primary street address. |
| address_line2 | string | Unit/suite/apt. |
| address_state | string | 2-letter state/province code. |
| address_country | string | 2-letter ISO country code. Defaults to US. |
{
"name": "lob_create_address",
"title": "Save an address record",
"description": "Create a reusable saved address record (does NOT send any mail). Returns an address id (adr_…) usable as `to`/`from` in mail tools. Lob API: POST /v1/addresses.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"address_line1"
],
"properties": {
"name": {
"type": "string",
"description": "Recipient name (required unless `company` is set)."
},
"company": {
"type": "string"
},
"address_zip": {
"type": "string",
"description": "ZIP / postal code."
},
"description": {
"type": "string",
"description": "Internal label for this address."
},
"address_city": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address."
},
"address_line2": {
"type": "string",
"description": "Unit/suite/apt."
},
"address_state": {
"type": "string",
"description": "2-letter state/province code."
},
"address_country": {
"type": "string",
"description": "2-letter ISO country code. Defaults to US."
}
}
},
"annotations": {
"title": "Save an address record",
"destructiveHint": true
}
}⚠️ SENDS A REAL POSTCARD and charges your Lob account (use a test_ key to avoid real mail/charges). `to` and `from` accept an existing address id (adr_…) or an inline address object. `front`/`back` accept an HTML string, a hosted asset URL, or a template id (tmpl_…). Cancelable only before `send_date`. Lob API: POST /v1/postcards.
| Parameter | Type | Description |
|---|---|---|
| to * | any | Either an existing address id (adr_…) or an inline address object. |
| back * | string | Back artwork: HTML string, asset URL, or template id (tmpl_…). |
| from | any | Return address (id or inline object). Optional. |
| size | string | Postcard size. Default 4x6. |
| front * | string | Front artwork: HTML string, asset URL, or template id (tmpl_…). |
| use_type | string | Lob mail use type: operational (bills, notices, legal letters) or marketing. Lob requires it unless the account has a default use type (Account Settings). |
| mail_type | string | USPS mail class. |
| send_date | string | ISO-8601 date/time to schedule the send (future). Cancelable until then. |
| description |
⚠️ SENDS A REAL LETTER and charges your Lob account (use a test_ key to avoid real mail/charges). `to`/`from` accept an address id (adr_…) or inline object. `file` accepts an HTML string, a hosted PDF/URL, or a template id (tmpl_…). `color` is required. Cancelable only before `send_date`. Tracked mail: `extra_service` = certified (U.S. addresses: tracking + proof of delivery), certified_return_receipt (certified + the recipient's electronic signature) or registered (international addresses only); extra cost, first class only, not for us_legal size. The tracking number is on the letter (lob_get_letter). Lob API: POST /v1/letters.
| Parameter | Type | Description |
|---|---|---|
| to * | any | Either an existing address id (adr_…) or an inline address object. |
| file * | string | Letter body: HTML string, asset/PDF URL, or template id (tmpl_…). |
| from * | any | Return address (id or inline object). Required for letters. |
| color * | boolean | true = color printing, false = black & white. |
| use_type | string | Lob mail use type: operational (bills, notices, legal letters) or marketing. Lob requires it unless the account has a default use type (Account Settings). |
| mail_type | string | USPS mail class. Default usps_first_class. extra_service needs first class. |
| send_date | string |
Cancel a postcard before its send_date so it is never mailed (and not billed). Fails if the send window has passed. Lob API: DELETE /v1/postcards/{id}.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Postcard id (psc_…) to cancel. |
{
"name": "lob_cancel_postcard",
"title": "Cancel a scheduled postcard",
"description": "Cancel a postcard before its send_date so it is never mailed (and not billed). Fails if the send window has passed. Lob API: DELETE /v1/postcards/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Postcard id (psc_…) to cancel."
}
}
},
"annotations": {
"title": "Cancel a scheduled postcard",
"destructiveHint": true
}
}Tools for Lob, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Is 185 Berry Street, San Francisco CA a deliverable address?"; "Which city and state does ZIP code 94107 belong to?"; "Show me the postcards I sent recently and their delivery status.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Lob data. Free plan: 50 tool calls per month. Run lob_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run lob_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run lob_upgrade without a plan: it returns both plans, each with a payment link for the user to open. lob_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
| string |
| Internal label. |
| merge_variables | object | Key/value data merged into HTML templates. |
{
"name": "lob_create_postcard",
"title": "Send a postcard (COSTS MONEY)",
"description": "⚠️ SENDS A REAL POSTCARD and charges your Lob account (use a test_ key to avoid real mail/charges). `to` and `from` accept an existing address id (adr_…) or an inline address object. `front`/`back` accept an HTML string, a hosted asset URL, or a template id (tmpl_…). Cancelable only before `send_date`. Lob API: POST /v1/postcards.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"to",
"front",
"back"
],
"properties": {
"to": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"required": [
"address_line1"
],
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_zip": {
"type": "string",
"description": "ZIP / postal code."
},
"address_city": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"type": "string",
"description": "Unit/suite/apt, e.g. 'Suite 6100'."
},
"address_state": {
"type": "string",
"description": "2-letter state/province code for US/CA."
},
"address_country": {
"type": "string",
"description": "2-letter ISO country code. Defaults to US."
}
},
"description": "Inline address object."
}
],
"description": "Either an existing address id (adr_…) or an inline address object."
},
"back": {
"type": "string",
"description": "Back artwork: HTML string, asset URL, or template id (tmpl_…)."
},
"from": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"required": [
"address_line1"
],
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_zip": {
"type": "string",
"description": "ZIP / postal code."
},
"address_city": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"type": "string",
"description": "Unit/suite/apt, e.g. 'Suite 6100'."
},
"address_state": {
"type": "string",
"description": "2-letter state/province code for US/CA."
},
"address_country": {
"type": "string",
"description": "2-letter ISO country code. Defaults to US."
}
},
"description": "Inline address object."
}
],
"description": "Return address (id or inline object). Optional."
},
"size": {
"enum": [
"4x6",
"6x9",
"6x11"
],
"type": "string",
"description": "Postcard size. Default 4x6."
},
"front": {
"type": "string",
"description": "Front artwork: HTML string, asset URL, or template id (tmpl_…)."
},
"use_type": {
"enum": [
"marketing",
"operational"
],
"type": "string",
"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)."
},
"mail_type": {
"enum": [
"usps_first_class",
"usps_standard"
],
"type": "string",
"description": "USPS mail class."
},
"send_date": {
"type": "string",
"description": "ISO-8601 date/time to schedule the send (future). Cancelable until then."
},
"description": {
"type": "string",
"description": "Internal label."
},
"merge_variables": {
"type": "object",
"description": "Key/value data merged into HTML templates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
}
},
"annotations": {
"title": "Send a postcard (COSTS MONEY)",
"destructiveHint": true
}
}| ISO-8601 date/time to schedule the send (future). Cancelable until then. |
| description | string | Internal label. |
| double_sided | boolean | Print on both sides. Default true. |
| extra_service | string | Tracked mail (extra cost): certified or certified_return_receipt for U.S. addresses, registered for international ones. Omit for ordinary mail. |
| merge_variables | object | Key/value data merged into HTML templates. |
| address_placement | string | Where the recipient address is placed. |
{
"name": "lob_create_letter",
"title": "Send a letter (COSTS MONEY)",
"description": "⚠️ SENDS A REAL LETTER and charges your Lob account (use a test_ key to avoid real mail/charges). `to`/`from` accept an address id (adr_…) or inline object. `file` accepts an HTML string, a hosted PDF/URL, or a template id (tmpl_…). `color` is required. Cancelable only before `send_date`. Tracked mail: `extra_service` = certified (U.S. addresses: tracking + proof of delivery), certified_return_receipt (certified + the recipient's electronic signature) or registered (international addresses only); extra cost, first class only, not for us_legal size. The tracking number is on the letter (lob_get_letter). Lob API: POST /v1/letters.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"to",
"from",
"file",
"color"
],
"properties": {
"to": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"required": [
"address_line1"
],
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_zip": {
"type": "string",
"description": "ZIP / postal code."
},
"address_city": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"type": "string",
"description": "Unit/suite/apt, e.g. 'Suite 6100'."
},
"address_state": {
"type": "string",
"description": "2-letter state/province code for US/CA."
},
"address_country": {
"type": "string",
"description": "2-letter ISO country code. Defaults to US."
}
},
"description": "Inline address object."
}
],
"description": "Either an existing address id (adr_…) or an inline address object."
},
"file": {
"type": "string",
"description": "Letter body: HTML string, asset/PDF URL, or template id (tmpl_…)."
},
"from": {
"anyOf": [
{
"type": "string",
"description": "Existing Lob address id (adr_…)."
},
{
"type": "object",
"required": [
"address_line1"
],
"properties": {
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address_zip": {
"type": "string",
"description": "ZIP / postal code."
},
"address_city": {
"type": "string"
},
"address_line1": {
"type": "string",
"description": "Primary street address, e.g. '210 King St'."
},
"address_line2": {
"type": "string",
"description": "Unit/suite/apt, e.g. 'Suite 6100'."
},
"address_state": {
"type": "string",
"description": "2-letter state/province code for US/CA."
},
"address_country": {
"type": "string",
"description": "2-letter ISO country code. Defaults to US."
}
},
"description": "Inline address object."
}
],
"description": "Return address (id or inline object). Required for letters."
},
"color": {
"type": "boolean",
"description": "true = color printing, false = black & white."
},
"use_type": {
"enum": [
"marketing",
"operational"
],
"type": "string",
"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)."
},
"mail_type": {
"enum": [
"usps_first_class",
"usps_standard"
],
"type": "string",
"description": "USPS mail class. Default usps_first_class. extra_service needs first class."
},
"send_date": {
"type": "string",
"description": "ISO-8601 date/time to schedule the send (future). Cancelable until then."
},
"description": {
"type": "string",
"description": "Internal label."
},
"double_sided": {
"type": "boolean",
"description": "Print on both sides. Default true."
},
"extra_service": {
"enum": [
"certified",
"certified_return_receipt",
"registered"
],
"type": "string",
"description": "Tracked mail (extra cost): certified or certified_return_receipt for U.S. addresses, registered for international ones. Omit for ordinary mail."
},
"merge_variables": {
"type": "object",
"description": "Key/value data merged into HTML templates.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"address_placement": {
"enum": [
"top_first_page",
"insert_blank_page",
"bottom_first_page_center",
"bottom_first_page"
],
"type": "string",
"description": "Where the recipient address is placed."
}
}
},
"annotations": {
"title": "Send a letter (COSTS MONEY)",
"destructiveHint": true
}
}