Lob
App · 20 actions
Verify addresses and manage direct mail, letters, postcards and mail templates.
Actions
| Action | What it does |
|---|---|
| Create a letter | Create a letter and send it by mail when connected with a live key. |
| Create an address | Add an address to your Lob address book. |
| Delete an address | Remove the selected address from your Lob address book. |
| Get a billing group | Read the selected record and its details. |
| Get a check | Read the selected record and its details. |
| Get a letter | Read the selected record and its details. |
| Get a postcard | Read the selected record and its details. |
| Get a self-mailer | Read the selected record and its details. |
| Get a template | Read the selected record and its details. |
| Get an address | Read the selected record and its details. |
| List addresses | Read one page of addresses in your Lob account. |
| List billing groups | Read one page of billing groups in your Lob account. |
| List checks | Read one page of checks in your Lob account. |
| List letters | Read one page of letters in your Lob account. |
| List postcards | Read one page of postcards in your Lob account. |
| List self-mailers | Read one page of self-mailers in your Lob account. |
| List templates | Read one page of templates in your Lob account. |
| Look up a US ZIP code | Find cities and states associated with a US ZIP code. |
| Suggest US addresses | Find suggested mailing addresses from the start of a US street address. |
| Verify a US address | Validate and standardize a US mailing address. |
Create a letter
Create a letter and send it by mail when connected with a live key.
Inputs
- To
totextRequired - To.
- From address
from_addresstextRequired - From address.
- File
filetextRequired - File.
- Color
colortrue/falseRequired - Color.
- Description
descriptiontext - Description.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"description": "example",
"id": "example",
"url": "example"
}
}Create an address
Add an address to your Lob address book.
Inputs
- Name
nametext - Name.
- Address line1
address_line1textRequired - Address line1.
- Address city
address_citytextRequired - Address city.
- Address state
address_statetextRequired - Address state.
- Address zip
address_ziptextRequired - Address zip.
- Address line2
address_line2text - Address line2.
- Company
companytext - Company.
- Phone
phonetext - Phone.
- Email
emailtext - Email.
- Address country
address_countrytext - Address country.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"address_city": "example",
"address_country": "example",
"address_line1": "example",
"address_line2": "example",
"address_state": "example",
"address_zip": "example",
"id": "example",
"name": "example"
}
}Delete an address
Remove the selected address from your Lob address book.
Inputs
- Address
address_idtextRequired - Address id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"deleted": false,
"id": "example"
}
}Get a billing group
Read the selected record and its details.
Inputs
- Billing group
billing_group_idtextRequired - Billing group id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"description": "example",
"id": "example",
"name": "example"
}
}Get a check
Read the selected record and its details.
Inputs
- Check
check_idtextRequired - Check id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"date_created": "example",
"description": "example",
"id": "example",
"tracking_events": []
}
}Get a letter
Read the selected record and its details.
Inputs
- Letter
letter_idtextRequired - Letter id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"date_created": "example",
"description": "example",
"id": "example",
"tracking_events": []
}
}Get a postcard
Read the selected record and its details.
Inputs
- Postcard
postcard_idtextRequired - Postcard id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"date_created": "example",
"description": "example",
"id": "example",
"tracking_events": []
}
}Get a self-mailer
Read the selected record and its details.
Inputs
- Self mailer
self_mailer_idtextRequired - Self mailer id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"date_created": "example",
"description": "example",
"id": "example",
"tracking_events": []
}
}Get a template
Read the selected record and its details.
Inputs
- Template
template_idtextRequired - Template id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"description": "example",
"id": "example",
"name": "example"
}
}Get an address
Read the selected record and its details.
Inputs
- Address
address_idtextRequired - Address id.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"address_city": "example",
"address_country": "example",
"address_line1": "example",
"address_line2": "example",
"address_state": "example",
"address_zip": "example",
"id": "example",
"name": "example"
}
}List addresses
Read one page of addresses in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List billing groups
Read one page of billing groups in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List checks
Read one page of checks in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List letters
Read one page of letters in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List postcards
Read one page of postcards in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List self-mailers
Read one page of self-mailers in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}List templates
Read one page of templates in your Lob account.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- After
aftertext - After.
- Before
beforetext - Before.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"data": [],
"next_url": "example",
"previous_url": "example"
}
}Look up a US ZIP code
Find cities and states associated with a US ZIP code.
Inputs
- Zip code
zip_codetextRequired - Zip code.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"cities": [],
"id": "example",
"zip_code": "example"
}
}Suggest US addresses
Find suggested mailing addresses from the start of a US street address. Uses account allowance.
Inputs
- Address prefix
address_prefixtextRequired - Address prefix.
- City
citytext - City.
- State
statetext - State.
- Zip code
zip_codetext - Zip code.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"id": "example",
"suggestions": []
}
}Verify a US address
Validate and standardize a US mailing address. Uses address verification allowance.
Inputs
- Primary line
primary_linetextRequired - Primary line.
- Secondary line
secondary_linetext - Secondary line.
- City
citytext - City.
- State
statetext - State.
- Zip code
zip_codetext - Zip code.
Outputs
Response.
dataobject- Data.
Example output
{
"data": {
"deliverability": "example",
"id": "example",
"last_line": "example",
"primary_line": "example"
}
}