Lob

Creates a new address given information

Deletes the details of an existing address. You need only supply the unique identifier that was returned upon address creation.

Retrieves the details of an existing address. You need only supply the unique identifier that was returned upon address creation.

Returns a list of your addresses. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.

Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us).

Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description "VERIFICATION".

Permanently deletes a bank account. It cannot be undone.

Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation.

Verify a bank account in order to create a check. Check the `microdeposit_type` field returned by `GET /v1/bank_accounts/:id` to determine which parameter to submit: - `amounts` — provide the two microdeposit amounts (in cents) that appeared in the bank account statement. - `descriptor_code` — provide the 6-character code (beginning with `SM`) from the bank statement descriptor of the single $0.01 microdeposit. Submitting the wrong parameter type for the account's `microdeposit_type` will return an error.

Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first.

Creates a new billing_group with the provided properties.

Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation.

Updates all editable attributes of the billing_group with the given id.

Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first.

Creates a new booklet.

Completely removes a booklet from production. This can only be done if the booklet's `send_date` has not yet passed. If the booklet is successfully canceled, you will not be charged for it.

Retrieves the details of an existing booklet. You need to only supply the unique booklet identifier that was returned upon booklet creation.

Returns a list of your booklets. The booklets are returned sorted by creation date, with the most recently created booklets appearing first.

Creates a new buckslip given information

Delete an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.

Creates a new buckslip order given information

Retrieves the buckslip orders associated with the given buckslip id.

Retrieves the details of an existing buckslip. You need only supply the unique customer identifier that was returned upon buckslip creation.

Update the details of an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.

Returns a list of your buckslips. The buckslips are returned sorted by creation date, with the most recently created buckslips appearing first.

Verify a list of international (except US or US territories) address _with a live API key_. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.

Verify a list of US or US territory addresses _with a live API key_. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.

Creates a new campaign with the provided properties. See how to launch your first campaign [here](https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/launch-your-first-campaign).

Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's `send_date` matches its associated mail pieces' `send_date`s.

Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.

Sends a campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.

Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation.

Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first.

Creates a new card given information

Delete an existing card. You need only supply the unique identifier that was returned upon card creation.

Creates a new card order given information

Retrieves the card orders associated with the given card id.

Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation.

Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation.

Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first.

Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a> to gain access.

Creates a new check with the provided properties.

Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation.

Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first.

Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a>. If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode.

Creates a new template version attached to the specified template.

Creates a new creative with the provided properties

Retrieves the details of an existing creative. You need only supply the unique creative identifier that was returned upon creative creation.

Update the details of an existing creative. You need only supply the unique identifier that was returned upon creative creation.

Add a new custom domain that can be used to create custom links.

Delete a registered domain. This operation can only be performed if all associated links with the domain are deleted.

Retrieve details for a single domain.

Retrieve a list of all created domains.

Retrieves the details of an existing export. You need only supply the unique export identifier that was returned upon export creation. If you try retrieving an export immediately after creating one (i.e., before we're done processing the export), you will get back an export object with `state = in_progress`.

Returns the account's current balance of Lob Credits.

Validates whether a given name is associated with an address.

Creates a new Informed Delivery campaign

List Informed Delivery campaigns

Retrieves the details of an existing Informed Delivery campaign. You need only supply the `usps_campaign_id` returned in the campaign creation request.

Update the details of an existing Informed Delivery campaign.<br> **NOTE:** you can only update a campaign in the `pending_approval` status.

Verify an international (except US or US territories) address _with a live API key_. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.

Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a> to gain access.

Creates a new letter given information

Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation.

Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first.

Given a long URL, shorten your URL either by using a custom domain or Lob's own short domain.

Update any of the properties of a shortened link.

Delete the shortened link.

Retrieves a single shortened link.

Retrieves a list of shortened links. The list is sorted by creation date, with the most recently created appearing first.

Creates a new postcard given information

Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a> to gain access.

Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation.

Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.

Returns a list of your QR codes. The QR codes are returned sorted by scan date, with the most recently scanned QR codes appearing first.

Retrieves the line item data for each row from the csv file associated with the upload id record. NOTE: This endpoint is currently feature flagged. Please reach out to Lob's support team if you would like access to this API endpoint.

Creates a new resource proof with the provided properties.

Retrieves the details of an existing resource proof. You need only supply the unique resource proof identifier.

Updates the specified resource proof.

Reverse geocode a valid US location with a live API key.

Creates a new self_mailer given information

Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. If the self mailer is successfully canceled, you will not be charged for it. This feature is exclusive to certain customers. Upgrade to the appropriate <a href="https://dashboard.lob.com/#/settings/editions" target="_blank">Print & Mail Edition</a> to gain access.

Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation.

Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first.

Creates a new snap_pack given information

Completely removes a snap pack from production. This can only be done if the snap pack's `send_date` has not yet passed. If the snap pack is successfully canceled, you will not be charged for it.

Retrieves the details of an existing snap_pack. You need to only supply the unique snap_pack identifier that was returned upon snap_pack creation.

Returns a list of your snap_packs. The snap_packs are returned sorted by creation date, with the most recently created snap_packs appearing first.

Permanently deletes a template. Deleting a template also deletes its associated versions. Deleted templates can not be used to create postcard, letter, or check resources.

Retrieves the details of an existing template. You need only supply the unique template identifier that was returned upon template creation.

Updates the description and/or published version of the template with the given id. To update the template's html, create a new version of the template.

Permanently deletes a template version. A template's `published_version` can not be deleted.

Retrieves the template version with the given template and version ids.

Updates the template version with the given template and version ids.

Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.

Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first.

Creates a new upload with the provided properties.

Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.

Campaign Exports can help you understand exactly which records in a campaign could not be created. By initiating and retrieving an export, you will get row-by-row errors for your campaign. For a step-by-step walkthrough of creating a campaign and exporting failures, see our [Campaigns Guide](https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/launch-your-first-campaign). Create an export file associated with an upload.

Upload an [audience file](https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide) and associate it with an upload.

Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.

Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.

Returns a list of your uploads. Optionally, filter uploads by campaign.

Verify a US or US territory address _with a live API key_. The address can be in components (e.g. `primary_line` is "210 King Street", `zip_code` is "94107") or as a single string (e.g. "210 King Street 94107"), but not as both. Requests using a test API key validate required fields but return empty values unless specific `primary_line` values are provided. See the [US Verifications Test Environment](#section/US-Verifications-Test-Env) for details.

Returns information about a ZIP code