diff --git a/dist/lob-api-bundled.yml b/dist/lob-api-bundled.yml index 21a28305..233e7ac9 100644 --- a/dist/lob-api-bundled.yml +++ b/dist/lob-api-bundled.yml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Lob - version: 1.19.43 + version: 1.19.44 description: | The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
license: @@ -18595,7 +18595,7 @@ components: - 11x9_bifold - 12x9_bifold - 17.75x9_trifold - description: Specifies the size of the self mailer. The `17.75x9_trifold` size is in beta. Contact support@lob.com or your account contact to learn more. + description: Specifies the size of the self mailer. default: 6x18_bifold self_mailer_details_returned: description: Properties that the self mailers in your Creative should have. See the `qr_code` attribute below to add a QR code to your creative. diff --git a/dist/lob-api-postman.json b/dist/lob-api-postman.json index 80194792..2ec76c3c 100644 --- a/dist/lob-api-postman.json +++ b/dist/lob-api-postman.json @@ -1,7 +1,7 @@ { "item": [ { - "id": "5d125a4b-4b3e-4786-8edd-4d574bda402d", + "id": "454da7fa-9cac-4706-ae0a-c4b55a2ede1f", "name": "Addresses", "description": { "content": "To add an address to your address book, you create a new address object. You can retrieve and delete individual\naddresses as well as get a list of addresses. Addresses are identified by a unique random ID.\n
\n", @@ -9,7 +9,7 @@ }, "item": [ { - "id": "3232d92e-8de6-4b7b-9f0a-3bc541dd5c68", + "id": "4059a3f4-4036-4191-a999-4a8104f4ca23", "name": "List", "request": { "name": "List", @@ -57,7 +57,13 @@ }, { "disabled": false, - "key": "date_created[ut_ad]", + "key": "date_created[cupidatat_f]", + "value": "ATTRIBUTE | \nDESCRIPTION | \n
---|---|
code | \n A consistent machine-keyable string identifying the error | \n
status_code | \n A conventional HTTP status code | \n
message | \n A human-readable, subject-to-change message with more details about the error | \n
STATUS_CODE | \nCODE | \nMESSAGE | \n
---|---|---|
200 | \n SUCCESS | \nSuccessful API request | \n
401 | \n UNAUTHORIZED | \nAuthorization error with your API key or account | \n
403 | \n FORBIDDEN | \nForbidden error with your API key or account | \n
404 | \n NOT FOUND | \nThe requested item does not exist | \n
422 | \n BAD REQUEST | \nThe query or body parameters did not pass validation | \n
429 | \n TOO MANY REQUESTS | \nToo many requests have been sent with an API key in a given amount of time | \n
500 | \n SERVER ERROR | \nAn internal server error occurred, please contact support@lob.com | \n
STATUS_CODE | \nCODE | \nMESSAGE | \n
---|---|---|
422 | \n BAD_REQUEST | \nAn invalid request was made. See error message for details. | \n
409/422 | \n CONFLICT | \nThis operation would leave data in a conflicted state. | \n
403 | \n FEATURE_LIMIT_REACHED | \nThe account has reached its resource limit and requires upgrading to add more. | \n
500 | \n INTERNAL_SERVER_ERROR | \nAn error has occured on Lob's servers. Please try request again. | \n
422 | \n INVALID | \nAn invalid request was made. See error message for details. | \n
422 | \n NOT_DELETABLE | \nAn attempt was made to delete a resource, but the resource cannot be deleted. | \n
404 | \n NOT_FOUND | \nThe requested resource was not found. | \n
408 | \n REQUEST_TIMEOUT | \nThe request took too long. Please try again. | \n
503 | \n SERVICE_UNAVAILABLE | \nThe Lob servers are temporarily unavailable. Please try again. | \n
404 | \n UNRECOGNIZED_ENDPOINT | \nThe requested endpoint doesn't exist. | \n
422 | \n UNSUPPORTED_LOB_VERSION | \nAn unsupported Lob API version was requested. | \n
STATUS_CODE | \nCODE | \nMESSAGE | \n
---|---|---|
401 | \n EMAIL_REQUIRED | \nAccount must have a verified email address before creating live resources. | \n
401 | \n UNAUTHORIZED | \nThe request isn't authorized. | \n
401 | \n UNAUTHORIZED_TOKEN | \nToken isn't authorized. | \n
401/403 | \n INVALID_API_KEY | \nThe API key is invalid. | \n
403 | \n PUBLISHABLE_KEY_NOT_ALLOWED | \nThe requested operation needs a secret key, not a publishable key. See [API Keys](#tag/API-Keys) for more information. | \n
429 | \n RATE_LIMIT_EXCEEDED | \nRequests were sent too quickly and must be slowed down. | \n
STATUS_CODE | \nCODE | \nMESSAGE | \n
---|---|---|
401 | \n PAYMENT_METHOD_UNVERIFIED | \nYou must have a verified bank account or credit card to submit live requests. | \n
404 | \n DELETED_BANK_ACCOUNT | \nChecks cannot be created with a deleted bank account. | \n
422 | \n ADDRESS_LENGTH_EXCEEDS_LIMIT | \nThe sum of to.address_line1 and to.address_line2 cannot surpass 50 characters. | \n
422 | \n BANK_ACCOUNT_ALREADY_VERIFIED | \nThe bank account has already been verified. | \n
422 | \n BANK_ERROR | \nThere's an issue with the bank account. | \n
403 | \n BILLING_ADDRESS_REQUIRED | \nIn order to create a live mail piece, your account needs to set up a billing address. | \n
422 | \n CUSTOM_ENVELOPE_INVENTORY_DEPLETED | \nCustom envelope inventory is depleted, and more will need to be ordered. | \n
422 | \n FAILED_DELIVERABILITY_STRICTNESS | \nThe to address doesn't meet strictness requirements.\n See Account Settings to configure strictness. | \n
422 | \n FILE_PAGES_BELOW_MIN | \nNot enough pages. | \n
422 | \n FILE_PAGES_EXCEED_MAX | \nToo many pages. | \n
422 | \n FILE_SIZE_EXCEEDS_LIMIT | \nThe file size is too large. See description for details. | \n
422 | \n FOREIGN_RETURN_ADDRESS | \nThe 'from' address must be a US address. | \n
422 | \n INCONSISTENT_PAGE_DIMENSIONS | \nAll pages of the input file must have the same dimensions. | \n
422 | \n INVALID_BANK_ACCOUNT | \nThe provided bank routing number is invalid. | \n
422 | \n INVALID_BANK_ACCOUNT_VERIFICATION | \nVerification amounts do not match. | \n
422 | \n INVALID_CHECK_INTERNATIONAL | \nChecks cannot be sent internationally. | \n
422 | \n INVALID_COUNTRY_COVID | \nThe postal service in the specified country is currently unable to process the request due to COVID-19 restrictions. | \n
422 | \n INVALID_FILE | \nThe file is invalid. | \n
422 | \n INVALID_FILE_DIMENSIONS | \nFile dimensions are incorrect for the selected mail type. | \n
422 | \n INVALID_FILE_DOWNLOAD_TIME | \nFile download from remote server took too long. | \n
422 | \n INVALID_FILE_URL | \nThe file URL when creating a resource is invalid. | \n
422 | \n INVALID_IMAGE_DPI | \nDPI must be at least 300. | \n
422 | \n INVALID_INTERNATIONAL_FEATURE | \nThe specified product cannot be sent to the destination. | \n
422 | \n INVALID_PERFORATION_RETURN_ENVELOPE | \nBoth `return_envelope` and `perforation` must be used together. | \n
422 | \n INVALID_TEMPLATE_HTML | \nThe provided HTML is invalid. | \n
422 | \n MAIL_USE_TYPE_CAN_NOT_BE_NULL | \n`use_type` must be one of \"marketing\" or \"operational\". Alternatively, an admin can set the account default use type in Account Settings. | \n
422 | \n MERGE_VARIABLE_REQUIRED | \nA required merge variable is missing. | \n
422 | \n MERGE_VARIABLE_WHITESPACE | \nMerge variable names cannot contain whitespace. | \n
422 | \n PDF_ENCRYPTED | \nAn encrypted PDF was provided. | \n
422 | \n SPECIAL_CHARACTERS_RESTRICTED | \nCannot use special characters for merge variable names. | \n
422 | \n UNEMBEDDED_FONTS | \nThe provided PDF contains non-standard unembedded fonts. See description for details. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
postcard.created | \n false | \n A postcard is successfully created (Lob returns a 200 status code). | \n
postcard.rejected | \n false | \n A postcard was not successfully created (Usually happens when one or more postcards fail the creation step during a batch request) | \n
postcard.rendered_pdf | \n false | \n A postcard's PDF proof is successfully rendered. | \n
postcard.rendered_thumbnails | \n false | \n A postcard's thumbnails are successfully rendered. | \n
postcard.deleted | \n false | \n A postcard is successfully canceled. | \n
postcard.mailed | \n true | \n A postcard receives a \"Mailed\" tracking event. Only enabled for certain Print & Mail Editions. | \n
postcard.in_transit | \n true | \n A postcard receives an \"In Transit\" tracking event. | \n
postcard.in_local_area | \n true | \n A postcard receives an \"In Local Area\" tracking event. | \n
postcard.processed_for_delivery | \n true | \n A postcard receives a \"Processed for Delivery\" tracking event. | \n
postcard.delivered | \n false | \n A postcard receives a \"Delivered\" tracking event. | \n
postcard.failed | \n false | \n A postcard receives a \"Failed\" rendering error or tracking event. | \n
postcard.re-routed | \n true | \n A postcard receives a \"Re-Routed\" tracking event. | \n
postcard.returned_to_sender | \n true | \n A postcard receives a \"Returned to Sender\" tracking event. | \n
postcard.international_exit | \n true | \n A postcard receives a \"International Exit\" tracking event. | \n
postcard.viewed | \n false | \n A postcard QR code or URL was scanned or viewed by the recipient. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
self_mailer.created | \n false | \n A self_mailer is successfully created (Lob returns a 200 status code). | \n
self_mailer.rejected | \n false | \n A self_mailer was not successfully created (Usually happens when one or more self_mailers fail the creation step during a batch request) | \n
self_mailer.rendered_pdf | \n false | \n A self_mailer's PDF proof is successfully rendered. | \n
self_mailer.rendered_thumbnails | \n false | \n A self_mailer's thumbnails are successfully rendered. | \n
self_mailer.deleted | \n false | \n A self_mailer is successfully canceled. | \n
self_mailer.mailed | \n true | \n A self_mailer receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions. | \n
self_mailer.in_transit | \n true | \n A self_mailer receives an \"In Transit\" tracking event. | \n
self_mailer.in_local_area | \n true | \n A self_mailer receives an \"In Local Area\" tracking event. | \n
self_mailer.processed_for_delivery | \n true | \n A self_mailer receives a \"Processed for Delivery\" tracking event. | \n
self_mailer.delivered | \n true | \n A self_mailer receives an \"Delivered\" tracking event. | \n
self_mailer.failed | \n false | \n A self_mailer receives an \"Failed\" rendering error or tracking event. | \n
self_mailer.re-routed | \n true | \n A self_mailer receives a \"Re-Routed\" tracking event. | \n
self_mailer.returned_to_sender | \n true | \n A self_mailer receives a \"Returned to Sender\" tracking event. | \n
self_mailer.international_exit | \n true | \n A self_mailer receives an \"International Exit\" tracking event. | \n
self_mailer.viewed | \n false | \n A self_mailer's QR code or URL was scanned or viewed by the recipient. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
letter.created | \n false | \n A letter is successfully created (Lob returns a 200 status code). | \n
letter.rejected | \n false | \n A letter was not successfully created (Usually happens when one or more letters fail the creation step during a batch request) | \n
letter.rendered_pdf | \n false | \n A letter's PDF proof is successfully rendered. | \n
letter.rendered_thumbnails | \n false | \n A letter's thumbnails are successfully rendered. | \n
letter.deleted | \n false | \n A letter is successfully canceled. | \n
letter.mailed | \n true | \n A letter receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions. | \n
letter.in_transit | \n true | \n A letter receives an \"In Transit\" tracking event. | \n
letter.in_local_area | \n true | \n A letter receives an \"In Local Area\" tracking event. | \n
letter.processed_for_delivery | \n true | \n A letter receives a \"Processed for Delivery\" tracking event. | \n
letter.delivered | \n true | \n A letter receives a \"Delivered\" tracking event. | \n
letter.failed | \n false | \n A letter receives a \"Failed\" rendering error or tracking event. | \n
letter.re-routed | \n true | \n A letter receives a \"Re-Routed\" tracking event. | \n
letter.returned_to_sender | \n true | \n A letter receives a \"Returned to Sender\" tracking event. | \n
letter.international_exit | \n true | \n A letter receives a \"International Exit\" tracking event. | \n
letter.viewed | \n false | \n A letter's QR code or URL was scanned or viewed by the recipient. | \n
letter.certified.mailed | \n true | \n A certified letter receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions. | \n
letter.certified.in_transit | \n true | \n A certified letter receives an \"In Transit\" tracking event. | \n
letter.certified.in_local_area | \n true | \n A certified letter receives an \"In Transit\" tracking event. | \n
letter.certified.processed_for_delivery | \n true | \n A certified letter receives a \"Processed for Delivery\" tracking event. | \n
letter.certified.re-routed | \n true | \n A certified letter receives a \"Re-Routed\" tracking event. | \n
letter.certified.returned_to_sender | \n true | \n A certified letter receives a \"Returned to Sender\" tracking event. | \n
letter.certified.delivered | \n true | \n A certified letter receives a \"Delivered\" tracking event. | \n
letter.certified.pickup_available | \n true | \n A certified letter receives a \"Pickup Available\" tracking event. | \n
letter.certified.issue | \n true | \n A certified letter receives an \"Issue\" tracking event. | \n
letter.return_envelope.created | \n false | \n A return envelope is created (occurs simultaneously with letter creation). | \n
letter.return_envelope.in_transit | \n true | \n A return envelope receives an \"In Transit\" tracking event. | \n
letter.return_envelope.in_local_area | \n true | \n A return envelope receives an \"In Local Area\" tracking event. | \n
letter.return_envelope.processed_for_delivery | \n true | \n A return envelope receives a \"Processed for Delivery\" tracking event. | \n
letter.return_envelope.re-routed | \n true | \n A return envelope receives a \"Re-Routed\" tracking event. | \n
letter.return_envelope.returned_to_sender | \n true | \n A return envelope receives a \"Returned to Sender\" tracking event. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
check.created | \n false | \n A check is successfully created (Lob returns a 200 status code). | \n
check.rejected | \n false | \n A check was not successfully created (Usually happens when one or more checks fail the creation step during a batch request) | \n
check.rendered_pdf | \n false | \n A check's PDF proof is successfully rendered. | \n
check.rendered_thumbnails | \n false | \n A check's thumbnails are successfully rendered. | \n
check.deleted | \n false | \n A check is successfully canceled. | \n
check.mailed | \n true | \n A check receives a \"Mailed\" tracking event. Only enabled for certain Print & Mail Editions. | \n
check.in_transit | \n true | \n A check receives an \"In Transit\" tracking event. | \n
check.in_local_area | \n true | \n A check receives an \"In Local Area\" tracking event. | \n
check.processed_for_delivery | \n true | \n A check receives a \"Processed for Delivery\" tracking event. | \n
check.delivered | \n true | \n A check receives a \"Delivered\" tracking event. | \n
check.failed | \n false | \n A check receives a \"Failed\" rendering error or tracking event. | \n
check.re-routed | \n true | \n A check receives a \"Re-Routed\" tracking event. | \n
check.returned_to_sender | \n true | \n A check receives a \"Returned to Sender\" tracking event. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
address.created | \n false | \n An address is successfully created (Lob returns a 200 status code). | \n
address.deleted | \n false | \n An address is successfully deleted. | \n
EVENT TYPE | \nLIVE-ONLY | \nWHEN EVENT TYPE OCCURS | \n
---|---|---|
bank_account.created | \n false | \n A bank account is successfully created (Lob returns a 200 status code). | \n
bank_account.deleted | \n false | \n A bank account is successfully deleted. | \n
bank_account.verified | \n false | \n A bank account is successfully verified. | \n
DELIVERABILITY OF SAMPLE RESPONSE | \nSET primary_line TO | \n
---|---|
deliverable | \n deliverable | \n
deliverable_missing_info | \n deliverable missing info | \n
undeliverable | \n undeliverable | \n
no_match | \n no match | \n
X-Rate-Limit-Limit: | \nthe rate limit ceiling for a given request | \n
X-Rate-Limit-Remaining: | \nthe number of requests remaining in this window | \n
X-Rate-Limit-Reset: | \nthe time at which the rate limit window resets (in UTC epoch seconds)\n | \n
Idempotency-Key: | \n\n optional\n \n \n A string of no longer than 256 characters\n that uniquely identifies this resource.\n \n \n | \n
idempotency-key: | \n\n optional\n \n \n A string of no longer than 256 characters\n that uniquely identifies this resource.\n \n \n | \n
FONT NAME | \nTYPES | \n
---|---|
Arial | \n TrueType, CID TrueType | \n
Arial,Bold | \n TrueType, CID TrueType | \n
Arial,BoldItalic | \n TrueType, CID TrueType | \n
Arial,Italic | \n TrueType, CID TrueType | \n
ArialMT | \n TrueType, CID TrueType | \n
Arial-BoldMT | \n TrueType | \n
Arial-BoldItalicMT | \n TrueType | \n
Arial-ItalicMT | \n TrueType | \n
ArialNarrow | \n TrueType | \n
ArialNarrow-Bold | \n TrueType | \n
Calibri | \n TrueType | \n
Calibri-Bold | \n TrueType | \n
Calibri-Italic | \n TrueType | \n
Courier | \n Type 1 | \n
Courier-Oblique | \n Type 1 | \n
Courier-Bold | \n Type 1 | \n
Courier-BoldOblique | \n Type 1 | \n
CourierNewPSMT | \n TrueType | \n
CourierNewPS-ItalicMT | \n TrueType | \n
CourierNewPS-BoldMT | \n TrueType | \n
Helvetica | \n Type 1 | \n
Helvetica-Bold | \n Type 1 | \n
Helvetica-BoldOblique | \n Type 1 | \n
Helvetica-Oblique | \n Type 1 | \n
LucidaConsole | \n TrueType | \n
MsSansSerif | \n TrueType | \n
MsSansSerif,Bold | \n TrueType | \n
Symbol | \n Type 1, TrueType | \n
Tahoma | \n TrueType | \n
Tahoma-Bold | \n TrueType | \n
Times-Bold | \n Type 1 | \n
Times-BoldItalic | \n Type 1 | \n
Times-Italic | \n Type 1 | \n
Times-Roman | \n Type 1 | \n
TimesNewRomanPS-BoldItalicMT | \n TrueType | \n
TimesNewRomanPS-BoldMT | \n TrueType | \n
TimesNewRomanPS-ItalicMT | \n TrueType | \n
TimesNewRomanPSMT | \n TrueType, CID TrueType | \n
TimesNewRomanPSMT,Bold | \n TrueType | \n
Verdana | \n TrueType | \n
Verdana-Bold | \n TrueType | \n
Verdana,Italic | \n TrueType | \n
ZapfDingbats | \n Type 1 | \n
NAME | \nEVENT | \nDESCRIPTION | \nACTION REQUIRED | \n
---|---|---|---|
Mailed | \npackage_accepted | \n Package has been accepted into the carrier network for delivery. | \nfalse | \n
In Transit | \npackage_arrived | \n Package has arrived at an intermediate location in the carrier network. | \nfalse | \n
In Transit | \npackage_departed | \n Package has departed from an intermediate location in the carrier network. | \nfalse | \n
In Transit | \npackage_processing | \n Package is processing at an intermediate location in the carrier network. | \nfalse | \n
In Transit | \npackage_processed | \n Package has been processed at an intermediate location. | \nfalse | \n
In Local Area | \npackage_in_local_area | \n Package is at a location near the end destination. | \nfalse | \n
Processed For Delivery | \ndelivery_scheduled | \n Package is scheduled for delivery. | \nfalse | \n
Processed For Delivery | \nout_for_delivery | \n Package is out for delivery. | \nfalse | \n
Pickup Available | \npickup_available | \n Package is available for pickup at carrier location. | \ntrue | \n
Delivered | \ndelivered | \n Package has been delivered. | \nfalse | \n
Re-Routed | \npackage_forwarded | \n Package has been forwarded. | \nfalse | \n
Returned to Sender | \nreturned_to_sender | \n Package is to be returned to sender. | \nfalse | \n
Issue | \naddress_issue | \n Address information is incorrect. Contact carrier to ensure delivery. | \ntrue | \n
Issue | \ncontact_carrier | \n Contact the carrier for more information. | \ntrue | \n
Issue | \ndelayed | \n Delivery of package is delayed. | \nfalse | \n
Issue | \ndelivery_attempted | \n Delivery of package has been attempted. Contact carrier to ensure delivery. | \ntrue | \n
Issue | \ndelivery_rescheduled | \n Delivery of package has been rescheduled. | \nfalse | \n
Issue | \nlocation_inaccessible | \n Delivery location inaccessible to carrier. Contact carrier to ensure delivery. | \ntrue | \n
Issue | \nnotice_left | \n Carrier left notice during attempted delivery. Follow carrier instructions on notice. | \ntrue | \n
Issue | \npackage_damaged | \n Package has been damaged. Contact carrier for more details. | \ntrue | \n
Issue | \npackage_disposed | \n Package has been disposed. | \nfalse | \n
Issue | \npackage_held | \n Package held at carrier location. Contact carrier for more details. | \ntrue | \n
Issue | \npackage_lost | \n Package has been lost. Contact carrier for more details. | \ntrue | \n
Issue | \npackage_unclaimed | \n Package is unclaimed. | \ntrue | \n
Issue | \npackage_undeliverable | \n Package is not able to be delivered. | \ntrue | \n
Issue | \nreschedule_delivery | \n Contact carrier to reschedule delivery. | \ntrue | \n
Issue | \nother | \n Unrecognized carrier status. | \nfalse | \n
components[zip_code_type]
standard | \n The default ZIP code type. Used when none of the other types apply. | \n
po_box | \n The ZIP code contains only PO Boxes. | \n
unique | \n The ZIP code is uniquely assigned to a single organization (such as a government agency) that receives a large volume of mail. | \n
military | \n The ZIP code contains military addresses. | \n
empty string | \nA match could not be made with the provided inputs. | \n
components[record_type]
street | \n The default address type. | \n
highrise | \n The address is a commercial building, apartment complex, highrise, etc. | \n
firm | \n The address is of an organizational entity which receives a minimum number of mailpieces per day. | \n
po_box | \n The address is a PO Box. | \n
rural_route | \n The address exists on a Rural Route. This is an older system of mail delivery which is still used in some parts of the country. | \n
general_delivery | \n The address is part of the USPS General Delivery service, which allows individuals without permanent addresses to receive mail. | \n
empty string | \nA match could not be made with the provided inputs. | \n
components[carrier_route_type]
city_delivery | \n The default carrier route type. Used when none of the other types apply. | \n
rural_route | \n The carrier route is a Rural Route. This is an older system of mail delivery which is still used in some parts of the country. | \n
highway_contract | \n The carrier route is a Highway Contract Route. This is an older system of mail delivery which is still used in some parts of the country. | \n
po_box | \n The carrier route consists of PO Boxes. | \n
general_delivery | \n The carrier route is part of the USPS General Delivery service, which allows individuals without permanent addresses to receive mail. | \n
empty string | \nA match could not be made with the provided inputs. | \n
deliverability_analysis[dpv_footnotes]
AA | \n Some parts of the address (such as the street and ZIP code) are valid. | \n
A1 | \n The address is invalid based on given inputs. | \n
BB | \n The address is deliverable. | \n
CC | \n The address is deliverable by removing the provided secondary unit designator. | \n
TA | \n The address is deliverable by dropping a trailing alphabet from the primary number. | \n
IA | \n The address is an Informed Address. The recipient and the street address is replaced with a special code provided by the USPS. | \n
N1 | \n The address is deliverable but is missing a secondary information (apartment, unit, etc). | \n
F1 | \n The address is a deliverable military address. | \n
G1 | \n The address is a deliverable General Delivery address. General Delivery is a USPS service which allows individuals without permanent addresses to receive mail. | \n
U1 | \n The address is a deliverable unique address. A unique ZIP code is assigned to a single organization (such as a government agency) that receives a large volume of mail. | \n
C1 | \n The primary number was confirmed whereas the secondary number is unconfirmed and required to be deliverable. | \n
M1 | \n The primary number is missing. | \n
M3 | \n The primary number is invalid. | \n
P1 | \n PO Box, Rural Route, or Highway Contract box number is missing. | \n
P3 | \n PO Box, Rural Route, or Highway Contract box number is invalid. | \n
PB | \n The address is identified as PO Box street address. | \n
R1 | \n The address matched to a CMRA and private mailbox information is not present. | \n
R7 | \n The address matched to a Phantom Carrier Route (carrier_route of R777 ), which corresponds to physical addresses that are not eligible for delivery. | \n
RR | \n The address matched to a CMRA and private mailbox information is present. | \n
ADDRESS TYPE FOR SAMPLE RESPONSE | \nDELIVERABILITY | \nSET primary_line OR address TO | \n
---|---|---|
Commercial highrise | \ndeliverable | \n commercial highrise | \n
Residential highrise | \ndeliverable | \n residential highrise | \n
Residential house | \ndeliverable | \n residential house | \n
PO Box | \ndeliverable | \n po box | \n
Rural route | \ndeliverable | \n rural route | \n
Puerty Rico address w/ urbanization | \ndeliverable | \n puerto rico | \n
Military address | \ndeliverable | \n military | \n
Department of state | \ndeliverable | \n department of state | \n
Generic deliverable | \ndeliverable | \n deliverable | \n
Missing a suite number | \ndeliverable_missing_unit | \n missing unit | \n
Suite number doesn't exist | \ndeliverable_incorrect_unit | \n incorrect unit | \n
Residential house with unnecessary suite number | \ndeliverable_unnecessary_unit | \n unnecessary unit | \n
Undeliverable and block matched | \nundeliverable | \n undeliverable block match | \n
Undeliverable and no block matched | \nundeliverable | \n undeliverable no match | \n
The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
+ " fill="currentColor">The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
Lob’s Print & Mail and Address Verification APIs help companies transform outdated, manual print-and-mail processes; save 1,000s of hours in processing time by sending mail much more quickly; and increase ROI on offline communications.
@@ -3268,7 +3268,7 @@An array of tracking_event objects ordered by ascending time
. Will not be populated for postcards created in test mode.
Denotes resources created by the provided campaign id, prefixed with cmp_
. In the case of snap packs, booklets, and letters with size us_legal
, however, the campaign id is prefixed with camp_
instead of cmp_
.
The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6
or A5
postcard sizes.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6
or A5
postcard sizes.
A string describing the PDF render status:
processed
- the rendering process is currently in progress.Required if to
address is international. Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification.
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.
Customize and place a QR code on the creative at the required position.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6
or A5
postcard sizes.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6
or A5
postcard sizes.
ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. |
ratelimit-remaining | integer Example: 100 The number of requests remaining in the current window. @@ -3393,7 +3393,7 @@3. Learn more |
Array of objects or null (tracking_event_normal) An array of tracking_event objects ordered by ascending | |
campaign_id | string or null (campaign_id) ^(cmp|camp)_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
use_type | string or null (psc_use_type) Enum: "marketing" "operational" null The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article. - |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status:
3. Learn more |
merge_variables | object or null (merge_variables) <= 25000 characters You can input a merge variable payload object to your template or QR code redirect URLs to render dynamic content. For example, if you have a template like: |
string or string (send_date) A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the | |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. |
Array of objects (thumbnail) | |
expected_delivery_date | string <date> (expected_delivery_date) A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its |
date_created | string <date-time> (date_created) A timestamp in ISO 8601 format of the date the resource was created. |
date_modified | string <date-time> (date_modified) A timestamp in ISO 8601 format of the date the resource was last modified. @@ -3435,7 +3435,7 @@3. Learn more |
inside_template_version_id | string or null^vrsn_[a-zA-Z0-9]+$ The unique ID of the specific version of the HTML template used for the inside of the self mailer. |
object | string Default: "self_mailer" Value: "self_mailer" Value is resource type. |
Array of objects (tracking_event_certified) An array of certified tracking events ordered by ascending | |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status:
3. Learn more |
merge_variables | object or null (merge_variables) <= 25000 characters You can input a merge variable payload object to your template or QR code redirect URLs to render dynamic content. For example, if you have a template like: |
string or string (send_date) A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the | |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. |
adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object))) Required if | |
billing_group_id | string (billing_group_id) An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information. |
object (qr_code) Customize and place a QR code on the creative at the required position. - | |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. |
ratelimit-remaining | integer Example: 100 The number of requests remaining in the current window. @@ -3549,7 +3549,7 @@3. Learn more |
merge_variables | object or null (merge_variables) <= 25000 characters You can input a merge variable payload object to your template or QR code redirect URLs to render dynamic content. For example, if you have a template like: |
string or string (send_date) A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the | |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. |
Array of objects (thumbnail) | |
expected_delivery_date | string <date> (expected_delivery_date) A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its |
date_created | string <date-time> (date_created) A timestamp in ISO 8601 format of the date the resource was created. |
date_modified | string <date-time> (date_modified) A timestamp in ISO 8601 format of the date the resource was last modified. @@ -3560,7 +3560,7 @@3. Learn more |
inside_template_version_id | string or null^vrsn_[a-zA-Z0-9]+$ The unique ID of the specific version of the HTML template used for the inside of the self mailer. |
object | string Default: "self_mailer" Value: "self_mailer" Value is resource type. |
Array of objects (tracking_event_certified) An array of certified tracking events ordered by ascending | |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status:
3. Learn more |
template_id | string^tmpl_[a-zA-Z0-9]+$ The unique ID of the HTML template used for the letter. |
template_version_id | string^vrsn_[a-zA-Z0-9]+$ The unique ID of the specific version of the HTML template used for the letter. |
campaign_id | string or null (campaign_id) ^(cmp|camp)_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status:
3. Learn more |
custom_envelope | string or null (user_provided) ^env_[a-zA-Z0-9]+$ Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate Print & Mail Edition to gain access. |
billing_group_id | string (billing_group_id) An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information. |
object (qr_code) Customize and place a QR code on the creative at the required position. - | |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
size | string (ltr_size) Default: "us_letter" Enum: "us_letter" "us_legal" Specifies the size of the letter. It accepts two values Please note that attempting to include the |
The unique ID of the HTML template used for the letter.
The unique ID of the specific version of the HTML template used for the letter.
Denotes resources created by the provided campaign id, prefixed with cmp_
. In the case of snap packs, booklets, and letters with size us_legal
, however, the campaign id is prefixed with camp_
instead of cmp_
.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4
letter size.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4
letter size.
A string describing the PDF render status:
processed
- the rendering process is currently in progress.The unique ID of the specific version of the HTML template used for the inside of the snap pack.
Value is resource type.
An array of tracking events ordered by ascending time
. Not populated in test mode.
Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.
+Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.
A string describing the PDF render status:
processed
- the rendering process is currently in progress.The unique ID of the specific version of the HTML template used for the inside of the snap pack.
Value is resource type.
An array of tracking events ordered by ascending time
. Not populated in test mode.
Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.
+Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.
A string describing the PDF render status:
processed
- the rendering process is currently in progress.Denotes resources created by the provided campaign id, prefixed with cmp_
. In the case of snap packs, booklets, and letters with size us_legal
, however, the campaign id is prefixed with camp_
instead of cmp_
.
Specifies the size of the booklet.
Pages specifies the total number of pages in a booklet, where four pages make up one sheet. Pages must always be in increments of four to maintain booklet integrity. For a booklet with dimensions of 8.375x5.375 inches, we allow for 8, 12, 16, 20, 24, 28, or 32 pages.
-This is in beta. Contact support@lob.com or your account contact to learn more.
+This is in beta. Contact support@lob.com or your account contact to learn more.
A string describing the PDF render status:
processed
- the rendering process is currently in progress.A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the send_date
has passed, the mailpiece can be canceled. If a date in the format 2017-11-01
is passed, it will evaluate to midnight UTC of that date (2017-11-01T00:00:00.000Z
). If a datetime is passed, that exact time will be used. A send_date
passed with no time zone will default to UTC, while a send_date
passed with a time zone will be converted to UTC.
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.
Customize and place a QR code on the creative at the required position.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4
and us_legal
letter size.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4
and us_legal
letter size.
Defines the material used to create the mail piece, specifically for booklets. This property is directly tied to the size of the booklet, ensuring that the appropriate material is selected based on the booklet's dimensions. For booklets with size
equal to 8.375x5.375
inches, the default source material is 60# Gloss Text
.
ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. @@ -4238,7 +4238,7 @@3. Learn more |
campaign_id | string or null (campaign_id) ^(cmp|camp)_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
size | string (booklet_size) Default: "8.375x5.375" Value: "8.375x5.375" Specifies the size of the booklet. |
pages | integer (booklet_pages) Pages specifies the total number of pages in a booklet, where four pages make up one sheet. Pages must always be in increments of four to maintain booklet integrity. For a booklet with dimensions of 8.375x5.375 inches, we allow for 8, 12, 16, 20, 24, 28, or 32 pages. - |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. + |
fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. |
status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status:
Changelog |