Lob
API integration

get_single_lob_postcard_by_id

Get a specific Lob postcard by id. Returns the full postcard object including id, to and from address details, carrier, url, tracking_events, thumbnails, send_date, and expected_delivery_date. Required: id.

delete_a_lob_postcard_by_id

Cancel a scheduled Lob postcard and remove it from production. Can only be done before the send_date has passed. Returns: id. Scheduling and cancellation is a premium feature. Required: id.

list_all_lob_postcards

List Lob postcards ordered by creation date with the most recently created appearing first. Returns each postcard with id, to, from, url, carrier, front_template_id, back_template_id, size, mail_type, date_created, date_modified, send_date, expected_delivery_date, use_type, and object.

create_a_lob_postcard

Create a new Lob postcard with front and back artwork, recipient and sender addresses, and optional merge variables, QR codes, and scheduling. Returns the created postcard object including id, to, from, url, carrier, front_template_id, back_template_id, size, mail_type, date_created, date_modified, send_date, expected_delivery_date, use_type, and object. Required: to, front, back, use_type.

get_single_lob_letter_by_id

Retrieve a single Lob letter by id. Returns the full letter object including id, to and from addresses, url, carrier, color, double_sided, address_placement, extra_service, return_envelope, perforated_page, cards, buckslips, tracking_number, tracking_events, thumbnails, expected_delivery_date, send_date, date_created, and status. Required: id.

delete_a_lob_letter_by_id

Cancel a Lob letter and remove it from production. Can only be done before the send_date has passed. Returns: id, deleted. Scheduling and cancellation is a premium feature. Required: id.

list_all_lob_letters

List Lob letters sorted by creation date, most recently created first. Returns each letter with its id, description, to/from address objects, url, carrier, color, double_sided, mail_type, send_date, expected_delivery_date, date_created, tracking_number, thumbnails, and status. Optional filters include color, scheduled, mail_type, send_date, date_created, metadata, campaign_id, status, and sort_by.

create_a_lob_letter

Create a new Lob letter from an HTML string, a PDF URL, or an existing template id, with recipient and sender addresses and optional merge variables, return envelope, cards, and scheduling. Returns the created letter object including id, to, from, url, carrier, color, double_sided, address_placement, expected_delivery_date, date_created, and status. Required: to, from, file, color, use_type.

get_single_lob_self_mailer_by_id

Retrieve a single Lob self mailer by id. Returns the full self mailer object including id, description, to/from addresses, carrier, tracking events, thumbnails, size, mail type, expected delivery date, and send date. Required: id.

delete_a_lob_self_mailer_by_id

Cancel a Lob self mailer and remove it from production before its send_date has passed. Returns: id, deleted, object. Exclusive to certain Print & Mail Edition customers. Required: id.

list_all_lob_self_mailers

List Lob self mailers sorted by creation date, most recent first. Returns each self mailer with its id, description, to/from address objects, size, mail_type, carrier, expected_delivery_date, date_created, send_date, and thumbnails. Optional filters include size, mail_type, scheduled, send_date, date_created, metadata, campaign_id, and status.

create_a_lob_self_mailer

Create a new Lob self mailer with inside and outside artwork, recipient and sender addresses, and optional merge variables. Returns the created self mailer object including id, url, carrier, tracking_events, thumbnails, expected_delivery_date, date_created, and date_modified. Required: to, inside, outside, use_type.

list_all_lob_addresses

List Lob addresses sorted by creation date, with the most recently created appearing first. Returns: id, description, name, company, phone, email, address_line1, address_line2, address_city, address_state, address_zip, address_country, metadata, date_created, date_modified, object, recipient_moved.

create_a_lob_address

Create a new address in Lob. Returns the created address object including id, description, name, company, phone, email, address_line1, address_line2, address_city, address_state, address_zip, address_country, metadata, date_created, date_modified, object, and recipient_moved.

get_single_lob_address_by_id

Retrieve. Required: id.

delete_a_lob_address_by_id

Delete an existing Lob address by id. Returns: id. Required: id.

lob_bank_accounts_verify

Verify a Lob bank account via microdeposits to enable check creation. Submit amounts (two deposit amounts in cents) or descriptor_code (a 6-character SM-prefixed code) depending on the account's microdeposit_type; submitting the wrong parameter type returns an error. Returns: id, description, routing_number, account_number, signatory, account_type, metadata. Required: bank_id.

get_single_lob_bank_account_by_id

Get a Lob bank account by id. Returns: id, description. Required: id.

delete_a_lob_bank_account_by_id

Permanently delete a Lob bank account by id. This action cannot be undone. Returns: id. Required: id.

list_all_lob_bank_accounts

List Lob bank accounts sorted by creation date with the most recently created first. Returns: id, description, routing_number, account_number, signatory, account_type, metadata.

create_a_lob_bank_account

Create a new Lob bank account. Live-mode accounts must be verified via micro deposits before sending checks. Returns: id, description, routing_number, account_number, signatory, account_type, metadata. Required: routing_number, account_number, account_type, signatory.

get_single_lob_billing_group_by_id

Get a Lob billing group by id. Returns: id, description, object. Required: id.

update_a_lob_billing_group_by_id

Update editable attributes of a Lob billing group by id. Returns: id, name, description, date_created, date_modified, object. Required: id.

list_all_lob_billing_groups

List Lob billing groups sorted by creation date with the most recently created appearing first. Returns: id, name, description, date_created, date_modified, object. When using sort_by, specify either date_created or date_modified, not both.

create_a_lob_billing_group

Create a new billing group in Lob with a name and optional description. Returns: id, name, description, date_created, date_modified, object. Required: name.

get_single_lob_booklet_by_id

Get a Lob booklet by id. Returns the booklet object including id, description, to, from, mail_type, size, send_date, url, carrier, tracking_events, thumbnails, expected_delivery_date, date_created, date_modified, and object. Required: id.

delete_a_lob_booklet_by_id

Delete a Lob booklet by id, completely removing it from production. Can only be done before the booklet's send_date has passed; successfully canceled booklets are not charged. Returns the deleted booklet including id, description, to, from, mail_type, size, date_created, and date_modified. Required: id.

list_all_lob_booklets

List Lob booklets sorted by creation date (most recent first). Returns each booklet's id, description, to, from, mail_type, size, send_date, date_created, date_modified, and qr_code. Optional filters: include, date_created, metadata, send_date, mail_type, sort_by, campaign_id, status.

create_a_lob_booklet

Create a new Lob booklet for print and mail. Returns the created booklet object including id, description, to, from, mail_type, size, send_date, date_created, and date_modified. Required: to, from, file, use_type, size, pages.

list_all_lob_buckslips

List Lob buckslips sorted by creation date with the most recently created appearing first. Returns: id, account_id, description, auto_reorder, reorder_quantity, url, raw_url, front_original_url, back_original_url, thumbnails, available_quantity, pending_quantity, countries, status, mode, threshold_amount, date_created, date_modified, deleted, object.

create_a_lob_buckslip

Create a new Lob buckslip with front and back artwork PDFs. Returns: id, description, auto_reorder, url, object. Required: front.

get_single_lob_buckslip_by_id

Get a single Lob buckslip by id. Returns: id, description, url, object. Required: id.

update_a_lob_buckslip_by_id

Update the details of an existing Lob buckslip such as description and auto_reorder settings. Returns: id, description, auto_reorder, url, object. Required: id.

delete_a_lob_buckslip_by_id

Delete an existing Lob buckslip by id. Returns the deleted buckslip object including id, deleted, date_created, date_modified, and object. Required: id.

list_all_lob_buckslip_orders

List buckslip orders associated with a specific buckslip in Lob. Returns: id, quantity, date_created, date_modified, object. Required: buckslip_id.

create_a_lob_buckslip_order

Create a new buckslip order in Lob by specifying the print quantity. Returns: id, quantity, date_created, date_modified, object. Required: buckslip_id, quantity.

create_a_lob_bulk_us_verification

Verify a list of US or US territory addresses in bulk with Lob. Returns: addresses. Required: addresses.

create_a_lob_bulk_intl_verification

Bulk verify a list of international (non-US) addresses with a live Lob API key. Returns an array of verification results including id, recipient, primary_line, deliverable, and country for each address. Test API keys return dummy responses based on the primary line input. Required: addresses.

list_all_lob_campaigns

List Lob campaigns sorted by creation date, with the most recently created campaigns appearing first. Returns: id, name, description, schedule_type, print_speed, send_date, metadata, date_created, date_modified, is_deleted, object.

create_a_lob_campaign

Create a new Lob campaign with the provided properties. Returns the created campaign object including id, name, description, schedule_type, and print_speed. Required: name, schedule_type, use_type.

get_single_lob_campaign_by_id

Get a single Lob campaign by id. Returns the campaign object including its id, name, description, schedule_type, print_speed, send_date, and date_created. Required: id.

update_a_lob_campaign_by_id

Update the details of an existing Lob campaign by id. Returns the updated campaign object including id, name, description, schedule_type, and print_speed. Required: id.

delete_a_lob_campaign_by_id

Delete an existing Lob campaign by id. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. Returns the deleted campaign object including id, name, description, schedule_type, and print_speed. Required: id.

lob_campaigns_send

Send a Lob campaign by supplying the unique campaign identifier returned upon campaign creation. Returns the campaign object including id, name, description, schedule_type, and print_speed. Required: cmp_id.

list_all_lob_cards

List Lob cards sorted by creation date, most recently created first. Returns: id, account_id, description, url, size, auto_reorder, reorder_quantity, raw_url, front_original_url, back_original_url, thumbnails, available_quantity, pending_quantity, countries, status, mode, orientation, threshold_amount, date_created, date_modified, object. The include parameter can request additional metadata such…

create_a_lob_card

Create a new Lob card with front and back artwork and a specified size. Returns: id, description, url, size, auto_reorder, object. Required: front.

get_single_lob_card_by_id

Get a single Lob card by id. Returns: id, description, url, object. Required: id.

update_a_lob_card_by_id

Update an existing Lob card's description and auto_reorder settings. Returns: id, description, url, size, auto_reorder, object. Required: id.

delete_a_lob_card_by_id

Delete an existing Lob card by id. Returns: id, object. Required: id.

list_all_lob_card_orders

List card orders associated with a specific Lob card. Returns: id, card_id, quantity, date_created, date_modified, object. Required: card_id.

create_a_lob_card_order

Create a new card order for a specific Lob card. Returns: id, quantity, object. Required: card_id, quantity.

list_all_lob_checks

List Lob checks sorted by creation date, with the most recently created checks appearing first. Returns: id, description, metadata, to, from, bank_account, amount, memo, logo, check_bottom, check_number, merge_variables, url, carrier, tracking_events, thumbnails, mail_type, print_speed, date_created, date_modified, send_date, use_type, object. Optional filters include scheduled, mail_type,…

create_a_lob_check

Create a new check in Lob with the provided bank account, amount, and mailing details. Returns the created check object including id, bank_account, amount, check_number, url, carrier, date_created, and object.

get_single_lob_check_by_id

Get a single Lob check by id. Returns the full check object including id, description, bank_account, amount, memo, check_number, mail_type, date_created, date_modified, url, to, from, and thumbnails. Required: id.

delete_a_lob_check_by_id

Cancel a scheduled Lob check by id, removing it from production before the send_date has passed. Returns: id, object. Can only be canceled if the check has a send_date that has not yet passed; scheduling and cancellation is a premium feature. Required: id.

create_a_lob_creative

Create a new creative in Lob with the provided properties. Returns the created creative object including id, campaign_id, resource_type, description, details, date_created, and date_modified.

get_single_lob_creative_by_id

Retrieve a single Lob creative by id. Returns the creative object including id, campaign_id, resource_type, description, details, date_created, and date_modified. Required: id.

update_a_lob_creative_by_id

Update the details of an existing Lob creative by id. Returns: id, campaign_id, resource_type, description, details, date_created, date_modified, object. Required: id.

create_a_lob_identity_validation

Validate whether a given name is associated with an address in Lob. Returns: recipient, primary_line, secondary_line, city, state, zip_code.

list_all_lob_informed_delivery_campaigns

List Informed Delivery campaigns in Lob. Returns: usps_campaign_id, ride_along_url, ride_along_image, quantity, start_date, status.

create_a_lob_informed_delivery_campaign

Create a new Informed Delivery campaign in Lob by providing the ride-along image, URL, quantity, start date, and status. Returns: usps_campaign_id, ride_along_url, ride_along_image, quantity, start_date, status.

get_single_lob_informed_delivery_campaign_by_id

Get a single Informed Delivery campaign in Lob by id (usps_campaign_id). Returns: usps_campaign_id, ride_along_url, ride_along_image, quantity, start_date, status. Required: id.

update_a_lob_informed_delivery_campaign_by_id

Update an existing Informed Delivery campaign in Lob. Only campaigns in the pending_approval status can be updated. Returns: usps_campaign_id, ride_along_url, ride_along_image, quantity, start_date, status. Required: id.

create_a_lob_intl_verification

Verify a single international address (excluding US and US territories) with Lob. The address may be supplied as components (primary_line, city, state, postal_code, country) or as a single-line address string, but not both. Returns: id, recipient, primary_line, secondary_line, last_line, country, deliverable, components, object.

list_all_lob_qr_code_analytics

List QR code analytics in Lob, sorted by scan date with the most recently scanned QR codes appearing first. Returns: id, resource_id, date_created, date_modified, object. Results can be filtered by scan status or resource IDs.

get_single_lob_domain_by_id

Get a single Lob domain by id. Returns the domain object including id, domain, and status. Required: id.

delete_a_lob_domain_by_id

Delete a registered Lob domain by id. This operation can only be performed if all associated links with the domain have been deleted. Returns the deleted domain object including id and domain. Required: id.

list_all_lob_domains

List all Lob domains, optionally filtered by configuration status. Returns each domain with id, domain, date_created, date_modified, deleted, and status.

create_a_lob_domain

Create a new custom domain in Lob for generating custom short links. Returns the created domain object including id, domain, and status. Required: domain.

get_single_lob_link_by_id

Get a single Lob shortened link by id. Returns: id, title, domain_id, redirect_link, short_link, metadata, created_at, updated_at, slug, domain, resource_id, dateCreated, dateModified, deleted. Required: id.

update_a_lob_link_by_id

Update properties of a shortened Lob link by id. Returns: id, title, domain_id, redirect_link, short_link, metadata, created_at, updated_at, slug, domain, resource_id, dateCreated, dateModified, deleted. Required: id, redirect_link.

delete_a_lob_link_by_id

Delete a shortened Lob link by id. Returns: id, deleted, redirect_link, slug, domain, resource_id, dateCreated, dateModified. Required: id.

list_all_lob_links

List all Lob shortened links sorted by creation date, most recent first. Returns: id, title, domain_id, redirect_link, short_link, metadata, created_at, updated_at, slug, domain, resource_id, dateCreated, dateModified, deleted. Optional filters: campaign_id, domain_id.

create_a_lob_link

Create a shortened Lob link from a long URL, optionally with a custom domain or slug. Returns: id, title, domain_id, redirect_link, short_link, metadata, created_at, updated_at, slug, domain, resource_id, dateCreated, dateModified, deleted. Required: redirect_link.

get_single_lob_resource_proof_by_id

Get a Lob resource proof by id. Returns: id, object. Required: id.

update_a_lob_resource_proof_by_id

Update a Lob resource proof by id. Returns: id, resource_type, resource_parameters, template_id, object. Required: id.

create_a_lob_resource_proof

Create a new Lob resource proof with the provided resource type and parameters. Returns: id, resource_type, resource_parameters, template_id, object.

get_single_lob_snap_pack_by_id

Retrieve a single Lob snap pack by id. Returns the full snap pack object including id, to and from addresses, url, carrier, size, color, inside_template_id, outside_template_id, thumbnails, tracking_events, expected_delivery_date, send_date, date_created, and status. Required: id.

delete_a_lob_snap_pack_by_id

Cancel a Lob snap pack and remove it from production. Can only be done before the send_date has passed. Returns: id, deleted. Required: id.

list_all_lob_snap_packs

List Lob snap packs sorted by creation date, most recently created first. Returns each snap pack with its id, description, to/from address objects, size, mail_type, carrier, url, thumbnails, send_date, expected_delivery_date, date_created, and status. Optional filters include mail_type, send_date, date_created, metadata, campaign_id, status, and sort_by.

create_a_lob_snap_pack

Create a new Lob snap pack with inside and outside artwork, recipient and sender addresses, and optional merge variables and scheduling. Returns the created snap pack object including id, to, from, url, carrier, size, inside_template_id, outside_template_id, expected_delivery_date, date_created, and status. Required: to, inside, outside, use_type.

list_all_lob_template_versions

List Lob template versions for a given template, sorted by creation date with the most recently created appearing first. Returns: id, description, html, engine, date_created, date_modified, date_deleted, object. Required: tmpl_id.

update_a_lob_template_version_by_id

Update a Lob template version's description and/or HTML by template and version id. Returns the updated template version including id, description, html, engine, date_created, date_modified, and object. Required: id, tmpl_id.

delete_a_lob_template_version_by_id

Delete a template version in Lob. Returns: id, deleted, object. A template's published_version cannot be deleted. Required: id, tmpl_id.

create_a_lob_template_version

Create a new template version attached to a specific Lob template. Returns: id, description, html, date_created, date_modified, object. Required: tmpl_id, html.

get_single_lob_template_version_by_id

Get a single Lob template version by its template id and version id. Returns: id, description, html, date_created, date_modified, object. Required: id, tmpl_id.

get_single_lob_template_by_id

Get a single Lob template by id. Returns the full template object including id, description, published_version, versions, metadata, html, engine, date_created, and date_modified. Required: id.

update_a_lob_template_by_id

Update a Lob template's description and/or published version by id. To update the template's html, create a new version. Returns the updated template object including id, description, published_version, versions, metadata, html, engine, date_created, and date_modified. Required: id.

delete_a_lob_template_by_id

Permanently delete a Lob template by id. Deleting a template also deletes its associated versions. Returns: id. Required: id.

list_all_lob_templates

List Lob templates sorted by creation date, with the most recently created first. Returns: id, description, published_version, versions, metadata, html, engine, date_created, date_modified.

create_a_lob_template

Create a new Lob template for use with the Print & Mail API. Returns the created template object including id, description, published_version, versions, metadata, html, engine, date_created, and date_modified. In Live mode, creating templates past your Print & Mail Edition limit returns a 403 error. Required: html.

list_all_lob_uploads

List Lob uploads, optionally filtered by campaign. Returns each upload's id, dateCreated, dateModified, deleted, s3Url, state, type, uploadId.

create_a_lob_upload

Create a new upload in Lob to import an audience file for a campaign. Returns: id, dateCreated, dateModified, deleted, s3Url, state, type, uploadId. Required: campaignId.

get_single_lob_upload_by_id

Get a single Lob upload by its unique upload identifier. Returns: id, dateCreated, dateModified, deleted, s3Url, state, type, uploadId. Required: id.

update_a_lob_upload_by_id

Update the details of an existing Lob upload, supplying only the unique identifier returned at creation and the fields to modify. Returns: id, dateCreated, dateModified, deleted, s3Url, state, type, uploadId. Required: id.

delete_a_lob_upload_by_id

Delete an existing upload in Lob by id. You need only supply the unique identifier that was returned upon upload creation. Returns an empty 204 response on success. Required: id.

create_a_lob_upload_file

Upload an audience file to Lob and associate it with an existing upload. Returns a 202 Accepted response on success indicating asynchronous processing. Required: upl_id.

create_a_lob_upload_export

Create an export file associated with a Lob upload to get row-by-row campaign record errors. Returns the export object including id, dateCreated, dateModified, state, s3Url, type, uploadId, and deleted. Required: upl_id.

get_single_lob_upload_export_by_id

Retrieve the details of an existing Lob upload export by id. Returns the export object including id, dateCreated, dateModified, state, s3Url, type, uploadId, and deleted. Required: id, upl_id.

list_all_lob_upload_reports

Retrieve the line item report for a Lob upload. Returns per-row CSV line item data including rowNumber, status, errorMessage, mailpieceId, and originalData. This endpoint is currently feature flagged. Required: upl_id.

create_a_lob_us_autocompletion

Autocomplete a partial US address in Lob and return up to 10 full address suggestions. Returns: id. Not all suggestions are valid addresses and may need separate verification. Required: address_prefix.

create_a_lob_us_reverse_geocode_lookup

Reverse geocode a valid US location in Lob using latitude and longitude coordinates. Returns: id, object. The optional size parameter controls the number of locations returned (1–50, defaults to 5). Required: latitude, longitude.

create_a_lob_us_verification

Verify a single US or US territory address in Lob. The address can be supplied as components (primary_line, city, state, zip_code) or as a single-line `address` string, but not as both. Returns: recipient, primary_line, secondary_line, urbanization, last_line.

create_a_lob_us_zip_lookup

Look up information about a US ZIP code in Lob. Returns the ZIP code lookup result including zip_code and associated geographic details. Required: zip_code.