Lob

App · 20 actions

Verify addresses and manage direct mail, letters, postcards and mail templates.

Actions

ActionWhat it does
Create a letterCreate a letter and send it by mail when connected with a live key.
Create an addressAdd an address to your Lob address book.
Delete an addressRemove the selected address from your Lob address book.
Get a billing groupRead the selected record and its details.
Get a checkRead the selected record and its details.
Get a letterRead the selected record and its details.
Get a postcardRead the selected record and its details.
Get a self-mailerRead the selected record and its details.
Get a templateRead the selected record and its details.
Get an addressRead the selected record and its details.
List addressesRead one page of addresses in your Lob account.
List billing groupsRead one page of billing groups in your Lob account.
List checksRead one page of checks in your Lob account.
List lettersRead one page of letters in your Lob account.
List postcardsRead one page of postcards in your Lob account.
List self-mailersRead one page of self-mailers in your Lob account.
List templatesRead one page of templates in your Lob account.
Look up a US ZIP codeFind cities and states associated with a US ZIP code.
Suggest US addressesFind suggested mailing addresses from the start of a US street address.
Verify a US addressValidate and standardize a US mailing address.

Create a letter

Create a letter and send it by mail when connected with a live key.

Inputs

TototextRequired
To.
From addressfrom_addresstextRequired
From address.
FilefiletextRequired
File.
Colorcolortrue/falseRequired
Color.
Descriptiondescriptiontext
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

Namenametext
Name.
Address line1address_line1textRequired
Address line1.
Address cityaddress_citytextRequired
Address city.
Address stateaddress_statetextRequired
Address state.
Address zipaddress_ziptextRequired
Address zip.
Address line2address_line2text
Address line2.
Companycompanytext
Company.
Phonephonetext
Phone.
Emailemailtext
Email.
Address countryaddress_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

Addressaddress_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 groupbilling_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

Checkcheck_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

Letterletter_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

Postcardpostcard_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 mailerself_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

Templatetemplate_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

Addressaddress_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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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

Limitlimitnumber
Limit.From 1 to 100.
Afteraftertext
After.
Beforebeforetext
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 codezip_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 prefixaddress_prefixtextRequired
Address prefix.
Citycitytext
City.
Statestatetext
State.
Zip codezip_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 lineprimary_linetextRequired
Primary line.
Secondary linesecondary_linetext
Secondary line.
Citycitytext
City.
Statestatetext
State.
Zip codezip_codetext
Zip code.

Outputs

Response.

dataobject
Data.
Example output
{
  "data": {
    "deliverability": "example",
    "id": "example",
    "last_line": "example",
    "primary_line": "example"
  }
}

On this page