Lob integration guide
VerifiedHow to connect Lob to WEXTL and use its 6 triggers and 106 actions in your workflows. About Lob: Print and mail API for sending letters, postcards and checks and verifying addresses.
- 6 triggers
- 44 searches
- 62 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation42 min read
This documentation is compiled from our integration source code, internal specs for Lob, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Lob credentials
- API KeypasswordRequired
In the dashboard open Settings, then API Keys. A key starting with test_ never prints or mails anything. A key starting with live_ prints, mails and is billed. A publishable key works only for address verification, so it may fail the connection check.[1]
- API Versiontext
Leave empty to use the version of your account. Enter a date such as 2020-02-11 only to try another version.[1]
Connect Lob in WEXTL
- Log in to your WEXTL account, add the Lob node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Lob account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Lob triggers and actions on WEXTL
The list below is a reference of every Lob node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Lob node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant trigger for Lob events.
| Field | Type |
|---|---|
| Event ID | text |
| Event Type | text |
| Resource | text |
| Resource ID | text |
| Date Created | date |
| Resource | text |
Watch New Addresses
TriggerScheduled watcher for new saved addresses.
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Address Line1 | text |
7other output fields
Watch New Checks
TriggerDetects fresh check mailings on a schedule.
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Memo | text |
| Check Number | number |
| Message | text |
| Use Type | text |
| From | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| ID | text |
18other output fields
Watch New Letters
TriggerNew letter detector with scheduled checks.
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Cards | array |
| Card | object |
| Buckslips | array |
| Buckslip | object |
| Return Address | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Color | boolean |
| Double Sided | boolean |
24other output fields
Watch New Postcards
TriggerSpots postcards added since the last run.
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Watch New Self Mailers
TriggerFinds folded mailers added since last time.
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Get a Bank Account
SearchDetails of one check account.
| Field | Type |
|---|---|
Bank AccountRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| Routing Number | text |
| Account Number | text |
| Account Type | text |
| Signatory | text |
| Check Template | text |
| Fractional Routing Number | text |
| City | text |
| State | text |
| Zipcode | text |
| Metadata | text |
9other output fields
Get a Billing Group
SearchCost-splitting group details.
| Field | Type |
|---|---|
Billing GroupRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| Name | text |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Get a Booklet
SearchDelivery progress of a booklet.
| Field | Type |
|---|---|
Booklet IDRequired | text |
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
| Date Created | date |
16other output fields
Get a Buckslip
SearchInsert design and reorder setting.
| Field | Type |
|---|---|
BuckslipRequired | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Threshold Amount | number |
| URL | text |
14other output fields
Get a Campaign
SearchSettings of a mail campaign.
| Field | Type |
|---|---|
CampaignRequired | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Billing Group ID | text |
| Name | text |
| Description | text |
| Schedule Type | text |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window Campaign Minutes | number |
8other output fields
Get a Card
SearchDesign details of a card.
| Field | Type |
|---|---|
CardRequired | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| URL | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Raw URL | text |
8other output fields
Get a Check
SearchPrinting and postal state of a check.
| Field | Type |
|---|---|
CheckRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Memo | text |
| Check Number | number |
| Message | text |
| Use Type | text |
| From | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| ID | text |
18other output fields
Get a Creative
SearchDesign and previews of a creative.
| Field | Type |
|---|---|
Creative IDRequired | text |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Template Preview Urls | text |
| Template Previews | array |
| Template Preview | text |
| Campaigns | array |
| Campaign | object |
| Resource Type | text |
| Details | object |
| Mail Type | text |
| Size | text |
| Inside Original URL | text |
| Outside Original URL | text |
| From | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text |
2other output fields
Get a Domain
SearchRegistration state of a link domain.
| Field | Type |
|---|---|
DomainRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Domain | text |
| Error Redirect Link | text |
| Status | text |
| Created At | text |
| Updated At | text |
Get a Letter
SearchDelivery progress and inserts of a letter.
| Field | Type |
|---|---|
LetterRequired | choice |
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Cards | array |
| Card | object |
| Buckslips | array |
| Buckslip | object |
| Return Address | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Color | boolean |
| Double Sided | boolean |
24other output fields
Get a Link
SearchShort URL and its destination.
| Field | Type |
|---|---|
LinkRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Domain ID | text |
| Redirect Link | text |
| Short Link | text |
| Metadata | text |
| Created At | text |
| Updated At | text |
Get a Postcard
SearchSpecs and mailing dates of a postcard.
| Field | Type |
|---|---|
PostcardRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Get a Resource Proof
SearchPreview result for a mail proof.
| Field | Type |
|---|---|
Resource Proof IDRequired | text |
| Field | Type |
|---|---|
| Template ID | text |
| Resource Type | text |
| Status | text |
| Thumbnails | array |
| Thumbnail | object |
| URL | text |
| Errors | array |
| Error | object |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Get a Self Mailer
SearchPostage type and merge data of a self mailer.
| Field | Type |
|---|---|
Self MailerRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Get a Snap Pack
SearchStored details of a snap pack.
| Field | Type |
|---|---|
Snap Pack IDRequired | text |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
18other output fields
Get a Template
SearchVersion history of a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| ID | text |
| Versions | array |
| Version | object |
| Published Version | object |
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Object | text |
| Metadata | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
Get a Template Version
SearchOne revision of a template design.
| Field | Type |
|---|---|
TemplateRequired | choice |
Template VersionRequired | choice |
| Field | Type |
|---|---|
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Required Var | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Merge Variables | text |
Get an Address
SearchOne stored address from the book.
| Field | Type |
|---|---|
AddressRequired | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Address Line1 | text |
7other output fields
Get an Informed Delivery Campaign
SearchProgress of a USPS email promotion.
| Field | Type |
|---|---|
USPS Campaign IDRequired | text |
| Field | Type |
|---|---|
| Quantity | number |
| Status | text |
| Ride Along URL | text |
| Start Date | date |
| Brand Name | text |
| USPS Title | text |
| Lob Campaign ID | text |
| ID | text |
| Object | text |
| Account ID | text |
| USPS Campaign ID | text |
11other output fields
Get an Upload
SearchColumn mapping of an audience upload.
| Field | Type |
|---|---|
UploadRequired | choice |
| Field | Type |
|---|---|
| Campaign ID | text |
| Required Address Column Mapping | object |
| Name | text |
| Address Line1 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Optional Address Column Mapping | object |
| Address Line2 | text |
| Company | text |
| Address Country | text |
| Metadata | object |
| Columns | array |
| Merge Variable Column Mapping | text |
| ID | text |
| Account ID | text |
| Mode | text |
| Failures URL | text |
| Original Filename | text |
| State | text |
6other output fields
Get an Upload Export
SearchState of an export and where to download it.
| Field | Type |
|---|---|
UploadRequired | choice |
Export IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| S3 URL | text |
| State | text |
| Type | text |
| Upload ID | text |
Get an Upload Report
SearchRow results of a processed upload.
| Field | Type |
|---|---|
UploadRequired | choice |
LimitRequired | number |
| Status | choice |
| Field | Type |
|---|---|
| Row Number | number |
| Status | text |
| Error Message | text |
| Mailpiece ID | text |
| Original Data | text |
Get the Credits Balance
SearchCredit amount remaining on the account.
| Field | Type |
|---|---|
| Balance | number |
List Addresses
SearchSaved addresses filtered by date or metadata.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Address Line1 | text |
7other output fields
List Bank Accounts
SearchCheck accounts registered on your Lob account.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| Description | text |
| Routing Number | text |
| Account Number | text |
| Account Type | text |
| Signatory | text |
| Check Template | text |
| Fractional Routing Number | text |
| City | text |
| State | text |
| Zipcode | text |
| Metadata | text |
9other output fields
List Billing Groups
SearchBilling groups in a date window.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Field | Type |
|---|---|
| Description | text |
| Name | text |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
List Booklets
SearchBooklet mailings with delivery filters.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Campaign | choice |
| Status | choice |
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
| Date Created | date |
16other output fields
List Buckslip Orders
SearchPrint runs ordered for one insert.
| Field | Type |
|---|---|
BuckslipRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Buckslip ID | text |
| Status | text |
| Quantity Ordered | number |
| Unit Price | number |
| Inventory | number |
| Cancelled Reason | text |
2other output fields
List Buckslips
SearchInsert designs in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Threshold Amount | number |
| URL | text |
14other output fields
List Campaigns
SearchMail campaigns in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Billing Group ID | text |
| Name | text |
| Description | text |
| Schedule Type | text |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window Campaign Minutes | number |
8other output fields
List Card Orders
SearchPrint runs ordered for one card.
| Field | Type |
|---|---|
CardRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Card ID | text |
| Status | text |
| Inventory | number |
| Quantity Ordered | number |
| Unit Price | number |
| Cancelled Reason | text |
2other output fields
List Cards
SearchCard designs in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| URL | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Raw URL | text |
8other output fields
List Checks
SearchChecks narrowed by status or schedule.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Status | choice |
| Scheduled | choice |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Memo | text |
| Check Number | number |
| Message | text |
| Use Type | text |
| From | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| ID | text |
18other output fields
List Domains
SearchLink hostnames registered in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Domain | text |
| Error Redirect Link | text |
| Status | text |
| Created At | text |
| Updated At | text |
List Informed Delivery Campaigns
SearchUSPS email promotions in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Quantity | number |
| Status | text |
| Ride Along URL | text |
| Start Date | date |
| Brand Name | text |
| USPS Title | text |
| Lob Campaign ID | text |
| ID | text |
| Object | text |
| Account ID | text |
| USPS Campaign ID | text |
11other output fields
List Letters
SearchLetters narrowed by print or delivery state.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Campaign | choice |
| Status | choice |
| Color | choice |
1other input field
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Cards | array |
| Card | object |
| Buckslips | array |
| Buckslip | object |
| Return Address | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Color | boolean |
| Double Sided | boolean |
24other output fields
List Links
SearchShort URLs, optionally by domain or campaign.
| Field | Type |
|---|---|
LimitRequired | number |
| Domain | choice |
| Campaign | choice |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Domain ID | text |
| Redirect Link | text |
| Short Link | text |
| Metadata | text |
| Created At | text |
| Updated At | text |
List Postcards
SearchPostcards narrowed by size or state.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Campaign | choice |
| Status | choice |
| Scheduled | choice |
1other input field
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
List QR Code Scans
SearchScan counts for printed QR codes.
| Field | Type |
|---|---|
LimitRequired | number |
| Scanned | choice |
| Mail Piece IDs | array |
| Mail Piece ID | text |
| Field | Type |
|---|---|
| Resource ID | text |
| Date Created | date |
| Number Of Scans | number |
| Scans | array |
| Scan | object |
List Self Mailers
SearchFolded mailers narrowed by size or state.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Campaign | choice |
| Status | choice |
| Scheduled | choice |
1other input field
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
List Snap Packs
SearchSnap pack mailings narrowed by type or time.
| Field | Type |
|---|---|
LimitRequired | number |
| Created From | date |
| Created Until | date |
| Metadata | array |
| Pair | object |
| Send Date From | date |
| Send Date Until | date |
| Mail Type | choice |
| Sort By | choice |
| Campaign | choice |
| Status | choice |
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
18other output fields
List Template Versions
SearchRevision history of one template.
| Field | Type |
|---|---|
TemplateRequired | choice |
LimitRequired | number |
| Field | Type |
|---|---|
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Required Var | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Merge Variables | text |
List Templates
SearchReusable HTML designs stored in the account.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| Description | text |
| ID | text |
| Versions | array |
| Version | object |
| Published Version | object |
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Object | text |
| Metadata | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
List Uploads
SearchAudience uploads, optionally per campaign.
| Field | Type |
|---|---|
LimitRequired | number |
| Campaign | choice |
| Field | Type |
|---|---|
| Campaign ID | text |
| Required Address Column Mapping | object |
| Name | text |
| Address Line1 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Optional Address Column Mapping | object |
| Address Line2 | text |
| Company | text |
| Address Country | text |
| Metadata | object |
| Columns | array |
| Merge Variable Column Mapping | text |
| ID | text |
| Account ID | text |
| Mode | text |
| Failures URL | text |
| Original Filename | text |
| State | text |
6other output fields
Autocomplete a US Address
ActionAddress suggestions from the start of a US street line.
| Field | Type |
|---|---|
Address PrefixRequired | text |
| City | text |
| State | text |
| ZIP Code | text |
| Sort by Location | boolean |
| Valid Addresses Only | boolean |
| Casing | choice |
| Field | Type |
|---|---|
| ID | text |
| Suggestions | array |
| Suggestion | object |
| Object | text |
Cancel a Booklet
ActionStops a booklet from being printed and mailed.
| Field | Type |
|---|---|
Booklet IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Cancel a Check
ActionCheck mailing aborted before printing.
| Field | Type |
|---|---|
CheckRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Cancel a Letter
ActionPrevents a letter from reaching the mail.
| Field | Type |
|---|---|
LetterRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Cancel a Postcard
ActionPostcard withdrawn ahead of production.
| Field | Type |
|---|---|
PostcardRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Cancel a Self Mailer
ActionWithdraws a folded mailer from the print run.
| Field | Type |
|---|---|
Self MailerRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Cancel a Snap Pack
ActionSnap pack pulled from the production queue.
| Field | Type |
|---|---|
Snap Pack IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Create a Bank Account
ActionBank account that checks are drawn on.
| Field | Type |
|---|---|
Routing NumberRequired | text |
Account NumberRequired | secret |
Account TypeRequired | choice |
SignatoryRequired | text |
| Description | text |
| Check Template | choice |
| Fractional Routing Number | text |
| City | text |
| State | text |
| ZIP Code | text |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| Description | text |
| Routing Number | text |
| Account Number | text |
| Account Type | text |
| Signatory | text |
| Check Template | text |
| Fractional Routing Number | text |
| City | text |
| State | text |
| Zipcode | text |
| Metadata | text |
9other output fields
Create a Billing Group
ActionNew group for separating mail charges.
| Field | Type |
|---|---|
NameRequired | text |
| Description | text |
| Field | Type |
|---|---|
| Description | text |
| Name | text |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Create a Booklet
ActionPrinted booklet mailed to an address.
| Field | Type |
|---|---|
Use TypeRequired | choice |
PagesRequired | number |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
| To Country | text |
26other input fields
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
| Date Created | date |
16other output fields
Create a Buckslip
ActionInsert artwork to slip into mailings.
| Field | Type |
|---|---|
| Front | text |
| Back | text |
| Size | choice |
| Description | text |
| Front PDF | text |
| Back PDF | text |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Threshold Amount | number |
| URL | text |
14other output fields
Create a Buckslip Order
ActionPrint run request for insert stock.
| Field | Type |
|---|---|
BuckslipRequired | choice |
QuantityRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Buckslip ID | text |
| Status | text |
| Quantity Ordered | number |
| Unit Price | number |
| Inventory | number |
| Cancelled Reason | text |
2other output fields
Create a Campaign
ActionContainer for a coordinated mailing.
| Field | Type |
|---|---|
NameRequired | text |
Schedule TypeRequired | choice |
Use TypeRequired | choice |
| Description | text |
| Billing Group | choice |
| Auto Cancel If NCOA | boolean |
| Print Speed | choice |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window (minutes) | number |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Billing Group ID | text |
| Name | text |
| Description | text |
| Schedule Type | text |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window Campaign Minutes | number |
8other output fields
Create a Card
ActionCard artwork to ship with letters.
| Field | Type |
|---|---|
| Front | text |
| Back | text |
| Size | choice |
| Description | text |
| Front PDF | text |
| Back PDF | text |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| URL | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Raw URL | text |
8other output fields
Create a Card Order
ActionPrint run request for card stock.
| Field | Type |
|---|---|
CardRequired | choice |
QuantityRequired | number |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Card ID | text |
| Status | text |
| Inventory | number |
| Quantity Ordered | number |
| Unit Price | number |
| Cancelled Reason | text |
2other output fields
Create a Check
ActionCheck payment mailed to a recipient.
| Field | Type |
|---|---|
Bank AccountRequired | choice |
AmountRequired | number |
Use TypeRequired | choice |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
29other input fields
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Memo | text |
| Check Number | number |
| Message | text |
| Use Type | text |
| From | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| ID | text |
18other output fields
Create a Creative
ActionMail piece design attached to a campaign.
| Field | Type |
|---|---|
CampaignRequired | choice |
Mail Piece TypeRequired | choice |
| From Address | choice |
| From Name | text |
| From Company | text |
| From Address Line 1 | text |
| From Address Line 2 | text |
| From City | text |
| From State | text |
| From ZIP Code | text |
| From Country | text |
6other input fields
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Template Preview Urls | text |
| Template Previews | array |
| Template Preview | text |
| Campaigns | array |
| Campaign | object |
| Resource Type | text |
| Details | object |
| Mail Type | text |
| Size | text |
| Inside Original URL | text |
| Outside Original URL | text |
| From | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text |
2other output fields
Create a Domain
ActionCustom hostname for short links.
| Field | Type |
|---|---|
DomainRequired | text |
| Error Redirect Link | text |
| Field | Type |
|---|---|
| ID | text |
| Domain | text |
| Error Redirect Link | text |
| Status | text |
| Created At | text |
| Updated At | text |
Create a Letter
ActionLetter sent by postal mail.
| Field | Type |
|---|---|
Use TypeRequired | choice |
ColorRequired | boolean |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
| To Country | text |
34other input fields
| Field | Type |
|---|---|
| Tracking Events | array |
| Tracking Event | object |
| Cards | array |
| Card | object |
| Buckslips | array |
| Buckslip | object |
| Return Address | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Description | text |
| Metadata | text |
| Merge Variables | text |
| Send Date | text |
| Mail Type | text |
| Color | boolean |
| Double Sided | boolean |
24other output fields
Create a Link
ActionBranded short URL for printed mail.
| Field | Type |
|---|---|
Redirect LinkRequired | text |
| Domain | choice |
| Slug | text |
| Title | text |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Domain ID | text |
| Redirect Link | text |
| Short Link | text |
| Metadata | text |
| Created At | text |
| Updated At | text |
Create a Postcard
ActionPostcard delivery through Lob.
| Field | Type |
|---|---|
Use TypeRequired | choice |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
| To Country | text |
| To Phone | text |
27other input fields
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Create a Resource Proof
ActionPreview render of a mail piece.
| Field | Type |
|---|---|
Mail Piece TypeRequired | choice |
Resource ParametersRequired | text |
| Template ID | text |
| Field | Type |
|---|---|
| Template ID | text |
| Resource Type | text |
| Status | text |
| Thumbnails | array |
| Thumbnail | object |
| URL | text |
| Errors | array |
| Error | object |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Create a Self Mailer
ActionFolded mailer sent to an address.
| Field | Type |
|---|---|
Use TypeRequired | choice |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
| To Country | text |
| To Phone | text |
27other input fields
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
17other output fields
Create a Snap Pack
ActionSnap pack sent to an address.
| Field | Type |
|---|---|
Use TypeRequired | choice |
| To Address | choice |
| To Name | text |
| To Company | text |
| To Address Line 1 | text |
| To Address Line 2 | text |
| To City | text |
| To State | text |
| To ZIP Code | text |
| To Country | text |
| To Phone | text |
26other input fields
| Field | Type |
|---|---|
| Description | text |
| Metadata | text |
| Mail Type | text |
| Merge Variables | text |
| Send Date | text |
| Print Speed | text |
| Size | text |
| To | object |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Carrier | text |
| Thumbnails | array |
| Thumbnail | object |
| Expected Delivery Date | date |
18other output fields
Create a Template
ActionReusable HTML design for mail.
| Field | Type |
|---|---|
HTMLRequired | text |
| Description | text |
| Engine | choice |
| Required Variables | array |
| Variable | text |
| Metadata | array |
| Pair | object |
| Field | Type |
|---|---|
| Description | text |
| ID | text |
| Versions | array |
| Version | object |
| Published Version | object |
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Object | text |
| Metadata | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
Create a Template Version
ActionNew revision added to a template design.
| Field | Type |
|---|---|
TemplateRequired | choice |
HTMLRequired | text |
| Description | text |
| Engine | choice |
| Required Variables | array |
| Variable | text |
| Field | Type |
|---|---|
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Required Var | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Merge Variables | text |
Create an Address
ActionStored recipient or sender address.
| Field | Type |
|---|---|
| Address Line 1 | text |
| Name | text |
| Company | text |
| Address Line 2 | text |
| City | text |
| State | text |
| ZIP Code | text |
| Country | text |
| Description | text |
| Phone | text |
| text |
1other input field
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text | |
| Address Line1 | text |
7other output fields
Create an Informed Delivery Campaign
ActionUSPS email promotion tied to mail pieces.
| Field | Type |
|---|---|
QuantityRequired | number |
Ride-Along URLRequired | text |
Start DateRequired | date |
Ride-Along ImageRequired | text |
| Representative Image | text |
| Brand Name | text |
| Campaign Title | text |
| Lob Campaign | choice |
| Status | choice |
| Field | Type |
|---|---|
| Quantity | number |
| Status | text |
| Ride Along URL | text |
| Start Date | date |
| Brand Name | text |
| USPS Title | text |
| Lob Campaign ID | text |
| ID | text |
| Object | text |
| Account ID | text |
| USPS Campaign ID | text |
11other output fields
Create an Upload
ActionAudience file setup for a campaign.
| Field | Type |
|---|---|
CampaignRequired | choice |
Required Address ColumnsRequired | text |
| Optional Address Columns | text |
| Merge Variable Columns | text |
| CSV Columns | array |
| Column | text |
| Field | Type |
|---|---|
| Campaign ID | text |
| Required Address Column Mapping | object |
| Name | text |
| Address Line1 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Optional Address Column Mapping | object |
| Address Line2 | text |
| Company | text |
| Address Country | text |
| Metadata | object |
| Columns | array |
| Merge Variable Column Mapping | text |
| ID | text |
| Account ID | text |
| Mode | text |
| Failures URL | text |
| Original Filename | text |
| State | text |
6other output fields
Create an Upload Export
ActionExport job for upload rows.
| Field | Type |
|---|---|
UploadRequired | choice |
RowsRequired | choice |
| Field | Type |
|---|---|
| Message | text |
| Export ID | text |
Delete a Bank Account
ActionCheck account detached from Lob.
| Field | Type |
|---|---|
Bank AccountRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Buckslip
ActionInsert artwork removed from Lob.
| Field | Type |
|---|---|
BuckslipRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Campaign
ActionCampaign entry erased from the account.
| Field | Type |
|---|---|
CampaignRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Card
ActionCard artwork removed from Lob.
| Field | Type |
|---|---|
CardRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Domain
ActionBranded hostname detached from the account.
| Field | Type |
|---|---|
DomainRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Link
ActionShort URL taken out of service.
| Field | Type |
|---|---|
LinkRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Template
ActionReusable HTML design removed from the account.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete a Template Version
ActionSingle revision removed from a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
Template VersionRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an Address
ActionStored recipient entry removed from the book.
| Field | Type |
|---|---|
AddressRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Deleted | boolean |
Delete an Upload
ActionAudience file setup removed.
| Field | Type |
|---|---|
UploadRequired | choice |
| Field | Type |
|---|---|
| Upload ID | text |
| Deleted | boolean |
Look Up a ZIP Code
ActionCity data for a US postal code.
| Field | Type |
|---|---|
ZIP CodeRequired | text |
| Field | Type |
|---|---|
| ZIP Code | text |
| ID | text |
| Cities | array |
| Citie | object |
| ZIP Code Type | text |
| Object | text |
Look Up an Address by Coordinates
ActionReverse geocode lookup for US coordinates.
| Field | Type |
|---|---|
LatitudeRequired | number |
LongitudeRequired | number |
| Number of Results | number |
| Field | Type |
|---|---|
| ID | text |
| Addresses | array |
| Addresse | object |
| Object | text |
Make an API Call
universalDirect Lob REST API access for uncovered endpoints.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Headers | object |
| Query String | array |
| Query String | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | text |
| Status Code | number |
Send a Campaign
ActionTriggers the mailing of a prepared campaign.
| Field | Type |
|---|---|
CampaignRequired | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Billing Group ID | text |
| Name | text |
| Description | text |
| Schedule Type | text |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window Campaign Minutes | number |
8other output fields
Update a Billing Group
ActionEdits a cost-splitting group.
| Field | Type |
|---|---|
Billing GroupRequired | choice |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| Description | text |
| Name | text |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Update a Buckslip
ActionReorder settings of an insert design.
| Field | Type |
|---|---|
BuckslipRequired | choice |
| Description | text |
| Auto Reorder | choice |
| Reorder Quantity | number |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Threshold Amount | number |
| URL | text |
14other output fields
Update a Campaign
ActionEdits a campaign before sending.
| Field | Type |
|---|---|
CampaignRequired | choice |
| Name | text |
| Description | text |
| Use Type | choice |
| Schedule Type | choice |
| Is Draft | choice |
| Auto Cancel If NCOA | choice |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window (minutes) | number |
| Metadata | array |
| Pair | object |
1other input field
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Billing Group ID | text |
| Name | text |
| Description | text |
| Schedule Type | text |
| Target Delivery Date | date |
| Send Date | date |
| Cancel Window Campaign Minutes | number |
8other output fields
Update a Card
ActionReorder settings of a card design.
| Field | Type |
|---|---|
CardRequired | choice |
| Description | text |
| Auto Reorder | choice |
| Reorder Quantity | number |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| Description | text |
| Size | text |
| ID | text |
| URL | text |
| Auto Reorder | boolean |
| Reorder Quantity | number |
| Raw URL | text |
8other output fields
Update a Creative
ActionEdits the sender and notes of a creative.
| Field | Type |
|---|---|
Creative IDRequired | text |
| From Address | choice |
| From Name | text |
| From Company | text |
| From Address Line 1 | text |
| From Address Line 2 | text |
| From City | text |
| From State | text |
| From ZIP Code | text |
| From Country | text |
| From Phone | text |
4other input fields
| Field | Type |
|---|---|
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Template Preview Urls | text |
| Template Previews | array |
| Template Preview | text |
| Campaigns | array |
| Campaign | object |
| Resource Type | text |
| Details | object |
| Mail Type | text |
| Size | text |
| Inside Original URL | text |
| Outside Original URL | text |
| From | object |
| Address Line1 | text |
| Address Line2 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Description | text |
| Name | text |
| Company | text |
| Phone | text |
| text |
2other output fields
Update a Link
ActionEdits the destination of a short URL.
| Field | Type |
|---|---|
LinkRequired | choice |
Redirect LinkRequired | text |
| Title | text |
| Metadata | array |
| Pair | object |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Title | text |
| Domain ID | text |
| Redirect Link | text |
| Short Link | text |
| Metadata | text |
| Created At | text |
| Updated At | text |
Update a Resource Proof
ActionSwaps the template on a proof.
| Field | Type |
|---|---|
Resource Proof IDRequired | text |
Template IDRequired | text |
| Field | Type |
|---|---|
| Template ID | text |
| Resource Type | text |
| Status | text |
| Thumbnails | array |
| Thumbnail | object |
| URL | text |
| Errors | array |
| Error | object |
| ID | text |
| Date Created | date |
| Date Modified | date |
| Object | text |
Update a Template
ActionEdits notes and live version of a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
| Description | text |
| Published Version | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Description | text |
| ID | text |
| Versions | array |
| Version | object |
| Published Version | object |
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Object | text |
| Metadata | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
Update a Template Version
ActionEdits a revision of a template.
| Field | Type |
|---|---|
TemplateRequired | choice |
Template VersionRequired | choice |
| Description | text |
| Engine | choice |
| Required Variables | array |
| Variable | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Description | text |
| HTML | text |
| Engine | text |
| Required Vars | array |
| Required Var | text |
| Date Created | date |
| Date Modified | date |
| Deleted | boolean |
| Object | text |
| ID | text |
| Suggest Json Editor | boolean |
| Merge Variables | text |
Update an Informed Delivery Campaign
ActionEdits a USPS email promotion.
| Field | Type |
|---|---|
USPS Campaign IDRequired | text |
| Quantity | number |
| Ride-Along URL | text |
| Start Date | date |
| Ride-Along Image | text |
| Representative Image | text |
| Brand Name | text |
| Campaign Title | text |
| Lob Campaign | choice |
| Status | choice |
| Field | Type |
|---|---|
| Quantity | number |
| Status | text |
| Ride Along URL | text |
| Start Date | date |
| Brand Name | text |
| USPS Title | text |
| Lob Campaign ID | text |
| ID | text |
| Object | text |
| Account ID | text |
| USPS Campaign ID | text |
11other output fields
Update an Upload
ActionEdits the column mapping of an upload.
| Field | Type |
|---|---|
UploadRequired | choice |
| File Name | text |
| Required Address Columns | text |
| Optional Address Columns | text |
| Merge Variable Columns | text |
| CSV Columns | array |
| Column | text |
| Field | Type |
|---|---|
| Campaign ID | text |
| Required Address Column Mapping | object |
| Name | text |
| Address Line1 | text |
| Address City | text |
| Address State | text |
| Address ZIP | text |
| Optional Address Column Mapping | object |
| Address Line2 | text |
| Company | text |
| Address Country | text |
| Metadata | object |
| Columns | array |
| Merge Variable Column Mapping | text |
| ID | text |
| Account ID | text |
| Mode | text |
| Failures URL | text |
| Original Filename | text |
| State | text |
6other output fields
Upload an Audience File
ActionLoads recipient rows into an upload.
| Field | Type |
|---|---|
UploadRequired | choice |
CSV FileRequired | text |
| Field | Type |
|---|---|
| Message | text |
| Filename | text |
Validate an Identity
ActionRecipient and address match check.
| Field | Type |
|---|---|
Primary LineRequired | text |
| Recipient | text |
| Company | text |
| Secondary Line | text |
| Urbanization | text |
| City | text |
| State | text |
| ZIP Code | text |
| Field | Type |
|---|---|
| ID | text |
| Recipient | text |
| Primary Line | text |
| Secondary Line | text |
| Urbanization | text |
| Last Line | text |
| Score | number |
| Confidence | text |
| Object | text |
| Company | text |
Verify a Bank Account
ActionConfirms a bank account with micro-deposits.
| Field | Type |
|---|---|
Bank AccountRequired | choice |
| Amounts | array |
| Amount (cents) | number |
| Descriptor Code | text |
| Field | Type |
|---|---|
| Description | text |
| Routing Number | text |
| Account Number | text |
| Account Type | text |
| Signatory | text |
| Check Template | text |
| Fractional Routing Number | text |
| City | text |
| State | text |
| Zipcode | text |
| Metadata | text |
9other output fields
Verify a US Address
ActionDeliverability check for a US address.
| Field | Type |
|---|---|
| Single-Line Address | text |
| Primary Line | text |
| Recipient | text |
| Secondary Line | text |
| Urbanization | text |
| City | text |
| State | text |
| ZIP Code | text |
| Casing | choice |
| Field | Type |
|---|---|
| ID | text |
| Recipient | text |
| Primary Line | text |
| Secondary Line | text |
| Urbanization | text |
| Last Line | text |
| Deliverability | text |
| Valid Address | boolean |
| Components | object |
| Primary Number | text |
| Street Predirection | text |
| Street Name | text |
| Street Suffix | text |
| Street Postdirection | text |
| Secondary Designator | text |
| Secondary Number | text |
| Pmb Designator | text |
| Pmb Number | text |
| Extra Secondary Designator | text |
| Deliverability Analysis | object |
| Dpv Confirmation | text |
| Dpv Cmra | text |
| Dpv Vacant | text |
| Dpv Active | text |
| Dpv Inactive Reason | text |
| Dpv Throwback | text |
| Dpv Non Delivery Day Flag | text |
| Dpv Non Delivery Day Values | text |
| Dpv No Secure Location | text |
| Dpv Door Not Accessible | text |
| Lob Confidence Score | object |
| Score | number |
| Level | text |
1other output field
Verify an International Address
ActionDeliverability check for a foreign address.
| Field | Type |
|---|---|
CountryRequired | choice |
| Single-Line Address | text |
| Primary Line | text |
| Recipient | text |
| Secondary Line | text |
| City | text |
| State | text |
| Postal Code | text |
| Field | Type |
|---|---|
| Recipient | text |
| Primary Line | text |
| Secondary Line | text |
| ID | text |
| Last Line | text |
| Country | text |
| Coverage | text |
| Deliverability | text |
| Status | text |
| Components | object |
| Primary Number | text |
| Street Name | text |
| City | text |
| State | text |
| Postal Code | text |
| Object | text |
Templates
Look for Lob templates in the WEXTL template library.
Browse templates →Other marketing integrations on WEXTL
Cardly[2]Preview and send printed greeting cards and letters, and manage artwork and contact lists.
ActiveTrailEmail, SMS and WhatsApp marketing with automations.
ActiveCampaignAutomate email marketing, CRM contacts, and customer journeys in ActiveCampaign.
BirdeyeReputation and local marketing for multi-location businesses. Collect and reply to reviews, sync listings across 50+ directories, manage contacts and campaigns, run surveys and tickets, publish social posts, and pull reputation, listings and competitor reports.
BeamerProduct update feed, feature requests and NPS surveys.
References
- WEXTL® Lob Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Lob.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.






























