diff --git a/dist/lob-api-bundled.yml b/dist/lob-api-bundled.yml index e840f954..ccb1d517 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.20.1 + version: 1.20.2 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: @@ -14544,8 +14544,6 @@ paths: state: in_progress type: failures uploadId: upl_71be866e430b11e9 - '403': - $ref: '#/components/responses/feature_flag_disabled' '404': $ref: '#/components/responses/upload_not_found' x-codeSamples: @@ -24469,22 +24467,6 @@ components: message: Invalid body, check 'errors' property for more info. errors: - type must be a string - feature_flag_disabled: - description: Forbidden Error - content: - application/json: - schema: - type: object - properties: - code: - description: The error code - type: number - message: - type: string - description: Details of the error message with the feature flagged mentioned. - example: - message: 'This feature is not enabled for this account: access_upload_report' - code: 403 us_autocompletions_error: description: Error content: diff --git a/dist/lob-api-postman.json b/dist/lob-api-postman.json index 89c93d44..d22f2c01 100644 --- a/dist/lob-api-postman.json +++ b/dist/lob-api-postman.json @@ -1,7 +1,7 @@ { "item": [ { - "id": "c8178f31-e73b-480f-a92b-3d1fb188b3ef", + "id": "7d5131a2-5704-4c68-8acb-6fd54e40e559", "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

back to top
\n", @@ -9,7 +9,7 @@ }, "item": [ { - "id": "6b5478a8-af46-4664-86ee-6926ad6f4ab8", + "id": "73b7afd1-2ca3-4d12-96c5-393544683c20", "name": "List", "request": { "name": "List", @@ -57,7 +57,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." } @@ -75,7 +93,7 @@ }, "response": [ { - "id": "df2b2f50-f7f2-48fd-b4c6-08f2b3599072", + "id": "b752ae70-2372-470b-839b-e6c3836e5b49", "name": "A dictionary with a data property that contains an array of up to `limit` addresses. Each entry in the array is a separate address object. The previous and next page of address entries can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more addresses are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -107,15 +125,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -147,7 +161,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a34b05d7-6bc1-437d-9118-67cf3a6f205f", + "id": "cfeaa832-b583-40b0-9257-0a189740295c", "name": "Error", "originalRequest": { "url": { @@ -179,15 +193,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -222,7 +232,7 @@ "event": [] }, { - "id": "3694de9e-a016-4092-a4ea-7192c69a8c8c", + "id": "edb32ed9-080c-40d2-9e67-4e2be7490c6f", "name": "Create", "request": { "name": "Create", @@ -285,7 +295,7 @@ }, "response": [ { - "id": "a38f4e32-79b5-4a7f-aa99-374a4c65f847", + "id": "a6ab5161-b2eb-460c-8fc3-4d62fa34cd72", "name": "Echos the writable fields of a newly created address object.", "originalRequest": { "url": { @@ -401,7 +411,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4e337d69-ec0a-4c1e-895d-b136c2c46a8b", + "id": "11dda6f4-cd40-4d37-b0eb-6249d73d3952", "name": "Error", "originalRequest": { "url": { @@ -505,7 +515,7 @@ } }, { - "id": "ee265718-f0b8-4114-9068-6d339c6eff75", + "id": "4aba6073-4e19-4cb1-b875-d47e53853685", "name": "Retrieve", "request": { "name": "Retrieve", @@ -543,7 +553,7 @@ }, "response": [ { - "id": "2fb2ad8e-f6e3-484c-8031-6e3ae5f85610", + "id": "d6e499a2-4eda-45cc-99ae-407617204dd3", "name": "Returns an address object if a valid identifier was provided.", "originalRequest": { "url": { @@ -591,7 +601,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d45febb4-9550-4aab-9458-bfc051a01cce", + "id": "1cab9b43-c91e-441a-8926-198e47cb0e03", "name": "Error", "originalRequest": { "url": { @@ -642,7 +652,7 @@ "event": [] }, { - "id": "4982b467-0b52-4b78-b571-2bb35c816e38", + "id": "ba2101d1-a855-4cc0-a912-cffe61d0b401", "name": "Delete", "request": { "name": "Delete", @@ -680,7 +690,7 @@ }, "response": [ { - "id": "90eb6573-2e82-4bd2-af7e-fc1aa2b5d161", + "id": "49fb50d9-a9aa-42e3-b03e-6376807ae893", "name": "Deleted", "originalRequest": { "url": { @@ -728,7 +738,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7eba474e-0bdd-489c-ac25-6c8c75f95208", + "id": "e9069d93-da99-4679-8c15-7738ae7c2656", "name": "Error", "originalRequest": { "url": { @@ -782,7 +792,7 @@ "event": [] }, { - "id": "ba0da586-54eb-45fa-987a-2628594ed64f", + "id": "ddd62abf-5a0d-4cca-a744-d9ae0613a529", "name": "Authentication", "description": { "content": "Requests made to the API are protected with HTTP Basic authentication.\nIn order to properly authenticate with the API you must use your API key as the username\nwhile leaving the password blank. Requests not properly authenticated will return a `401`\n[error code](#tag/Errors). You can find your account's API keys\nin your Dashboard Settings.\n### Example Request\ncurl uses the -u flag to pass basic auth credentials (adding a colon after your API key will prevent it from asking you for a\npassword). One of our test API keys has been filled into all the examples on the page, so you can test out any example right away.\n```bash\ncurl https://api.lob.com/v1/addresses \\\n -u test_0dc8dXXXXXXXXXXXXXXXXXXXXXX5b0cc:\n```\n## API Keys\n Lob authenticates your API requests using your account's API keys.\n If you do not include your key when making an API request, or use\n one that is incorrect or outdated, Lob returns an error with a `401`\n HTTP response code. You can find all API keys in your dashboard\n under Settings.\n There are two types of API keys: *secret* and *publishable*.\n - **Secret API keys** should be kept confidential and only stored on your own servers.\n Your account's secret API key can perform any API request to Lob without restriction.\n - **Publishable API keys** are limited to US verifications, international verifications,\n and US autocomplete requests. For maximum security, we encourage you to not expose your \n secret key. You can include the publishable keys in JavaScript code or in an Android or iPhone app\n without exposing your Lob Print and Mail account services or your secret key. Publishable keys are always\n prefixed with `[environment]_pub`.\n Every type comes with a pair of keys: one for the testing environment and one for the\n live environment. We recommend reading [Test and Live Environments](#tag/Test-and-Live-Environments)\n for more information.\n

\n
back to top
\n", @@ -792,7 +802,7 @@ "event": [] }, { - "id": "ec628afc-5669-4a80-800c-624598e8487f", + "id": "071a43d7-9a41-423d-b6c7-750e78f3b35b", "name": "Bank Accounts", "description": { "content": "Bank Accounts allow you to store your bank account securely in our system. The API provides\nendpoints for creating bank accounts, deleting bank accounts, verifying bank accounts,\nretrieving individual bank accounts, and retrieving a list of bank accounts.\n
back to top
\n", @@ -800,7 +810,7 @@ }, "item": [ { - "id": "01c9e8be-e236-456b-af9d-3ff6bbd3b79a", + "id": "5af50c7d-1851-45ff-b75c-1ad2fff1ecb7", "name": "Verify", "request": { "name": "Verify", @@ -860,7 +870,7 @@ }, "response": [ { - "id": "960e45f5-1681-4811-b3d8-21b1fd30dfbf", + "id": "cbd98934-82f3-47db-aed7-5132826ec52d", "name": "Returns a bank_account object", "originalRequest": { "url": { @@ -949,7 +959,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3d4706da-8e47-4fef-a668-7fc34d3575e1", + "id": "5985ee9d-115e-443c-8750-5760f2df2c99", "name": "Error", "originalRequest": { "url": { @@ -1026,7 +1036,7 @@ } }, { - "id": "b26601e5-cd8f-4095-82a8-052a0dc6e9a6", + "id": "d96cd5f5-f581-4aa4-86e4-dc39951546d6", "name": "Retrieve", "request": { "name": "Retrieve", @@ -1064,7 +1074,7 @@ }, "response": [ { - "id": "d9eef896-755b-4dc0-a663-8f84728adb31", + "id": "b8a44e09-4077-4c84-871b-a3079c98c32d", "name": "Returns a bank account object", "originalRequest": { "url": { @@ -1112,7 +1122,7 @@ "_postman_previewlanguage": "json" }, { - "id": "31c30cbe-65e9-41c4-a776-7d39fa07f69f", + "id": "112a2e4b-8bd4-4340-a057-6115c8a81773", "name": "Error", "originalRequest": { "url": { @@ -1163,7 +1173,7 @@ "event": [] }, { - "id": "3cc9c397-0bd5-46c1-bc9a-d18212d3c679", + "id": "39c74532-2b54-455a-b2b7-a67ee13ea053", "name": "Delete", "request": { "name": "Delete", @@ -1201,7 +1211,7 @@ }, "response": [ { - "id": "691cb7ca-fdab-4a38-90e3-99e5f41bb3c6", + "id": "d3058842-ea5e-42b5-a39a-56b44cdce137", "name": "Deleted", "originalRequest": { "url": { @@ -1249,7 +1259,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e9622d73-e2d0-4dc2-adaa-94ee4f9db4de", + "id": "f0b68724-a415-4d9a-a2db-5d9d8772c382", "name": "Error", "originalRequest": { "url": { @@ -1300,7 +1310,7 @@ "event": [] }, { - "id": "ef569641-c891-4e69-a982-6b3e02474e49", + "id": "59735104-fb16-413f-bd81-d615dcad1d35", "name": "List", "request": { "name": "List", @@ -1348,7 +1358,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." } @@ -1366,7 +1394,7 @@ }, "response": [ { - "id": "ac1e2537-1734-429e-9d49-39f43fc3de9a", + "id": "8beb42b8-3cce-489a-a61d-d8dba8e5a3ac", "name": "A dictionary with a data property that contains an array of up to `limit` bank_accounts. Each entry in the array is a separate bank_account. The previous and next page of bank_accounts can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more bank_accounts are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -1398,15 +1426,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -1438,7 +1462,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0381e252-2771-4b8f-a552-9bc963597b52", + "id": "0c4b652a-64da-4551-9c41-cf8cd281a9c0", "name": "Error", "originalRequest": { "url": { @@ -1470,15 +1494,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -1513,7 +1533,7 @@ "event": [] }, { - "id": "85da7953-86dd-44ee-8136-1d8134d0c8f7", + "id": "d29c784c-ce51-48ab-a5e6-8daa5308bb73", "name": "Create", "request": { "name": "Create", @@ -1610,7 +1630,7 @@ }, "response": [ { - "id": "9d4a09e1-e51e-48b2-9625-eb7397a856f4", + "id": "614a7798-cca9-4c35-ba46-4234f0c193ea", "name": "Returns a bank_account object", "originalRequest": { "url": { @@ -1717,7 +1737,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01550f9e-adc5-4327-b36a-40ab5a00bc76", + "id": "ce851ec3-678f-496f-a55f-121948d60918", "name": "Error", "originalRequest": { "url": { @@ -1815,7 +1835,7 @@ "event": [] }, { - "id": "bdc712b0-3b3e-4648-a1e4-32be97616059", + "id": "2ab1ca88-49ca-4bf6-b87c-fe3786e92408", "name": "Beta Program", "description": { "content": "At Lob, we pride ourselves on building high quality platform capabilities rapidly\nand iteratively, so we can constantly be delivering additional value to our customers.\nWhen evaluating a new product or feature from Lob, you may see that it has been released in Beta.\n\nTypically, something in Beta means that the feature is early in its lifecycle here at\nLob. While we fully stand behind the quality of everything we release in Beta, we do\nanticipate receiving a higher level of customer feedback on Beta features, as well as a\nfaster pace of changes from our engineering team in response to that feedback.\n\nBy participating in a Lob Beta program, you will have the opportunity to get early access\nto a new product capability, as well as having a unique opportunity to influence the product's\ndirection with your feedback.\n\nYou should also anticipate that features in Beta may have functional or design limitations,\nand might change rapidly as we receive customer feedback and make improvements. In particular,\nnew APIs in Beta may also go through more frequent versioning and version deprecation cycles\nthan our more mature APIs.\n\nIf you are participating in a Beta program and want to provide feedback, please feel free to\ncontact us!\n
back to top
\n", @@ -1825,7 +1845,7 @@ "event": [] }, { - "id": "1a2e37d5-1b13-4a78-8642-afc40e387d1e", + "id": "d8afca1f-5ead-444f-8883-9414008454b9", "name": "Billing Groups", "description": { "content": "The Billing Groups API allows you to create and view labels that can be attached to certain consumption-based\nusages of Letters, Checks, Postcards and Self-Mailers to customize your bill. Please check each\nresource API section to learn more about how to access the Billing Groups API.\n
back to top
\n", @@ -1833,7 +1853,7 @@ }, "item": [ { - "id": "9deb9ed8-ab24-496e-a558-be57cfe87be6", + "id": "d26c15a2-6cd9-4330-aa43-fe908c38be48", "name": "Retrieve", "request": { "name": "Retrieve", @@ -1871,7 +1891,7 @@ }, "response": [ { - "id": "c5681f5c-334d-42fc-8d53-b81bc01465cd", + "id": "af89705c-71b7-4402-8a09-8d911767492b", "name": "Returns a billing_group object.", "originalRequest": { "url": { @@ -1919,7 +1939,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c8e6b032-7943-4e45-a929-956d32f8101b", + "id": "192c8073-254a-4b8c-9469-13b332426c40", "name": "Error", "originalRequest": { "url": { @@ -1970,7 +1990,7 @@ "event": [] }, { - "id": "647ac311-5a6c-410f-9fa6-1cebe619c5f2", + "id": "da67fc43-a3a4-42c4-88ad-266961c76361", "name": "Update", "request": { "name": "Update", @@ -2027,7 +2047,7 @@ }, "response": [ { - "id": "b4305738-0e68-486b-aacd-de97ea6845cb", + "id": "34477af4-0412-4de9-9164-9e26b58f3c9e", "name": "Returns a billing group object", "originalRequest": { "url": { @@ -2107,7 +2127,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2dccd265-43a9-439d-9fc2-b9dfbb83aebf", + "id": "93669719-95c4-4057-9771-afbfdcddf3f7", "name": "Error", "originalRequest": { "url": { @@ -2175,7 +2195,7 @@ } }, { - "id": "5aadd068-3d75-418d-81d9-e5659be7521a", + "id": "97e76f17-da27-4b67-bee0-c896cb880523", "name": "List", "request": { "name": "List", @@ -2217,13 +2237,49 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, { "disabled": false, - "key": "date_modified[adipisicing2]", + "key": "date_created[id_9]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_modified[eiusmod5cd]", + "value": "", + "description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_modified[consecteturc97]", + "value": "", + "description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_modified[quis1d3]", + "value": "", + "description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_modified[id_9]", "value": "", "description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -2253,7 +2309,7 @@ }, "response": [ { - "id": "06aecefd-c27f-4146-a9d2-fb74c3c2b660", + "id": "a4d31743-9564-4ce3-8776-b3bae211a690", "name": "Returns a list of billing_groups.", "originalRequest": { "url": { @@ -2281,27 +2337,19 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", + "key": "date_created[pariatur_8]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_modified[fugiate77]", "value": "" }, { - "key": "date_modified[enim8]", - "value": "" - }, - { - "key": "date_modified[velit3]", - "value": "" - }, - { - "key": "date_modified[aliqua_2]", + "key": "date_modified[pariatur_8]", "value": "" }, { @@ -2341,7 +2389,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e7be3fa4-ad58-4b1d-84a3-d6b9361eaede", + "id": "f0e54edf-5e08-4723-97de-fb1b7322eac8", "name": "Error", "originalRequest": { "url": { @@ -2369,27 +2417,19 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_modified[enim8]", + "key": "date_created[pariatur_8]", "value": "" }, { - "key": "date_modified[velit3]", + "key": "date_modified[fugiate77]", "value": "" }, { - "key": "date_modified[aliqua_2]", + "key": "date_modified[pariatur_8]", "value": "" }, { @@ -2432,7 +2472,7 @@ "event": [] }, { - "id": "1899d243-7872-4ace-a8c5-abea0e494b93", + "id": "e9e523ec-c8b6-47a1-a1ce-c7518510d446", "name": "Create", "request": { "name": "Create", @@ -2480,7 +2520,7 @@ }, "response": [ { - "id": "5f5d9621-6afb-4e57-b439-059b5462cb9f", + "id": "ad35eb4b-8d42-428c-8153-b54194bc2b5d", "name": "Returns a billing group object", "originalRequest": { "url": { @@ -2551,7 +2591,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4a632cfa-cc46-4e48-99d8-24218025f452", + "id": "ecc52593-0a8b-4c6e-8d5c-3b725874bc36", "name": "Error", "originalRequest": { "url": { @@ -2613,7 +2653,7 @@ "event": [] }, { - "id": "2c120e65-9b7f-4030-ae28-83990e05d8e2", + "id": "cf4184d6-35d8-4980-961a-b0ab67b3c853", "name": "Buckslip Orders", "description": { "content": "The Buckslip Orders endpoint allows you to easily create buckslip orders for existing buckslips.\nThe API provides endpoints for creating buckslip orders and listing buckslip orders for a given buckslip.\n
back to top
\n", @@ -2621,7 +2661,7 @@ }, "item": [ { - "id": "e9344d3c-8787-4a6e-9bc0-adf7fb72ce87", + "id": "e029aeac-ee2e-470c-bc3b-4004f024798c", "name": "Retrieve", "request": { "name": "Retrieve", @@ -2673,7 +2713,7 @@ }, "response": [ { - "id": "f1b0c458-3618-432f-af1e-c7c7e5175ebb", + "id": "d4317a4f-9fa1-4bc1-954b-d9abca0aeedd", "name": "Returns the buckslip orders associated with the given buckslip id", "originalRequest": { "url": { @@ -2731,7 +2771,7 @@ "_postman_previewlanguage": "json" }, { - "id": "73c0ef72-6f96-411f-980c-76fa27f52151", + "id": "5fc94673-a34e-4b21-bc62-63ec82614549", "name": "Error", "originalRequest": { "url": { @@ -2792,7 +2832,7 @@ "event": [] }, { - "id": "134ef9e9-70fc-4bba-ab81-801ec3568daf", + "id": "9b7ff8a4-23b9-4b41-a39c-bc0b8a0c704c", "name": "Create", "request": { "name": "Create", @@ -2846,7 +2886,7 @@ }, "response": [ { - "id": "41f7e078-13f4-4614-85d5-bfda68bc3ba4", + "id": "7c8deb8f-4951-4979-b0c9-8f1e68dd73ae", "name": "Buckslip order created successfully", "originalRequest": { "url": { @@ -2908,7 +2948,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4d18dcf1-810d-4acf-85a6-61883d37636c", + "id": "aee0e5e9-b991-4b6c-88b7-ae74bcc5e728", "name": "Error", "originalRequest": { "url": { @@ -2979,7 +3019,7 @@ "event": [] }, { - "id": "07e767ba-d902-4c7c-8222-77ccaac1cd64", + "id": "2d3a3b92-8dda-4a49-b9eb-229a9119b5a0", "name": "Buckslips", "description": { "content": "The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters.\nThe API provides endpoints for creating buckslips, retrieving individual buckslips, creating buckslip orders, and retrieving a list of buckslips.\n
back to top
\n", @@ -2987,7 +3027,7 @@ }, "item": [ { - "id": "fb8e5302-8064-4e3c-8deb-f0607b7f498e", + "id": "b6a5634f-ed50-4b2c-b4ea-b78833ce15ba", "name": "List", "request": { "name": "List", @@ -3047,7 +3087,7 @@ }, "response": [ { - "id": "7c5e6e89-fec8-4190-88bd-607900aeae86", + "id": "0756c732-b08c-4030-8a89-5f14828e8f1f", "name": "Returns a list of buckslip objects", "originalRequest": { "url": { @@ -3107,7 +3147,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b632295d-8eba-4b46-b9d4-f2b637257a34", + "id": "494aee4b-c1f5-4a4f-b50c-4814f3e2c04f", "name": "Error", "originalRequest": { "url": { @@ -3170,7 +3210,7 @@ "event": [] }, { - "id": "df91aa9c-58a9-4435-a09c-a1919378a253", + "id": "bb6798fc-300a-4067-900d-cbf662fa80b2", "name": "Create", "request": { "name": "Create", @@ -3228,7 +3268,7 @@ }, "response": [ { - "id": "c54cbc66-067e-435d-bb83-9a727c612ac9", + "id": "2220b07f-b4d1-4d47-bf90-e3963e70ca6f", "name": "Buckslip created successfully", "originalRequest": { "url": { @@ -3286,7 +3326,7 @@ "_postman_previewlanguage": "json" }, { - "id": "75aac5af-ba1c-4e55-9a20-95f0eca2c5a2", + "id": "d83d31f6-3028-4ca7-a714-8e125cff045b", "name": "Error", "originalRequest": { "url": { @@ -3350,7 +3390,7 @@ } }, { - "id": "6687036c-0529-403d-9a75-45a556da7bfb", + "id": "0e616433-928c-4b13-b8e3-1de53d64913b", "name": "Retrieve", "request": { "name": "Retrieve", @@ -3388,7 +3428,7 @@ }, "response": [ { - "id": "0c241aad-021d-4295-8636-8c01d8289eb3", + "id": "68083ec3-6abc-4b49-b848-2b747ac288fb", "name": "Returns a buckslip object", "originalRequest": { "url": { @@ -3436,7 +3476,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d24a7d15-3d0d-41d4-9da3-ac5d51aa225b", + "id": "aabfca41-4d1e-4e06-a11f-582cbe6c4bee", "name": "Error", "originalRequest": { "url": { @@ -3487,7 +3527,7 @@ "event": [] }, { - "id": "6bda2142-9050-4914-b306-2283409131d0", + "id": "ec1e3cdd-22ce-4d19-ad05-19baeab0e835", "name": "Update", "request": { "name": "Update", @@ -3551,7 +3591,7 @@ }, "response": [ { - "id": "bb55185f-9378-4531-93cf-03a2882b13bf", + "id": "ee856f3a-ebca-4f12-be09-8a3faec4f5a7", "name": "Returns a buckslip object", "originalRequest": { "url": { @@ -3617,7 +3657,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cd7c78b1-5e75-4044-ac58-6270f34b9da5", + "id": "5e4e04d9-af74-4749-9e8a-a476303f5a75", "name": "Error", "originalRequest": { "url": { @@ -3689,7 +3729,7 @@ } }, { - "id": "968d4051-7de1-4a23-b99d-a43acf246c66", + "id": "006858f0-f7c1-4225-8ef0-b5ca908e54a8", "name": "Delete", "request": { "name": "Delete", @@ -3727,7 +3767,7 @@ }, "response": [ { - "id": "b6a5c8cd-ebf0-4243-82f3-1d33be6a44a5", + "id": "fc6aeb45-c2d2-4902-a739-06479b907f27", "name": "Deleted the buckslip", "originalRequest": { "url": { @@ -3775,7 +3815,7 @@ "_postman_previewlanguage": "json" }, { - "id": "613ed2e2-1706-43bb-8632-e26f8be78b33", + "id": "64b88d49-859d-4264-8032-3b63213e481e", "name": "Error", "originalRequest": { "url": { @@ -3829,7 +3869,7 @@ "event": [] }, { - "id": "3934c25d-8d07-4c91-ab83-990c9ae872a3", + "id": "b1725f53-c68a-4e74-b9bb-7bdf4219f158", "name": "Bulk Intl Verifications", "description": { "content": "Verify a list of non-US addresses.\n
back to top
\n", @@ -3839,7 +3879,7 @@ "event": [] }, { - "id": "8a44ba4c-ad02-4f85-a28b-b8c03af88b51", + "id": "8f94720f-ba50-4f38-9977-408f21254c5f", "name": "Bulk US Verifications", "description": { "content": "Verify a list of US addresses.\n
back to top
\n", @@ -3849,7 +3889,7 @@ "event": [] }, { - "id": "d53a3f52-6ce1-4b0f-ba80-da4abb03d442", + "id": "a55557d1-d18a-472f-b2ab-e9729596d12b", "name": "Campaigns", "description": { "content": "The campaigns endpoint allows you to create and view campaigns that can be used to send multiple letters or postcards.\nThe API provides endpoints for creating campaigns, updating campaigns, retrieving individual campaigns, listing campaigns, and deleting\ncampaigns.\n", @@ -3857,7 +3897,7 @@ }, "item": [ { - "id": "747762ed-2b4a-43a6-80c4-d9237d3345c2", + "id": "90cc9647-4215-4ba6-941a-15574dba9882", "name": "List", "request": { "name": "List", @@ -3917,7 +3957,7 @@ }, "response": [ { - "id": "427b8c8a-1b00-4528-98c9-96a143ab5020", + "id": "98c16331-0882-4788-8c7a-ef3458972063", "name": "A dictionary with a data property that contains an array of up to `limit` campaigns. Each entry in the array is a separate campaign. The previous and next page of campaigns can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more campaigns are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -3980,7 +4020,7 @@ "event": [] }, { - "id": "b373b06a-b5f6-4689-951d-e53e9331cc3c", + "id": "9739036d-ed6f-40d3-8779-57c3e6559fca", "name": "Create", "request": { "name": "Create", @@ -4069,7 +4109,7 @@ { "disabled": false, "key": "metadata", - "value": "+xZIU9a^3FikYZxtrmrOk47bdZ7Uh#e'G.%2fC8F$ Ft~vh_YTBJQzkY1iB$1zF)2Q_W]S7pz!bmKY^dhe$'HgoK=2n=gK.^0H?);'HUa5?%SoH!=Pl-z&J|A+V$tW(5P&-1)Mu`YMob{('lj.QYkC3B0P%,H.%:2wLhi,G#92Gc0Q^5U(Z:+6}4Ak?HbkXK[0_z+>5@r_]oL6)^2vFO(o$@X@L|DYo>Wo_|Wi|UZCae[D%zWezJ`Vcfj+l`M8;m7b5.&;v]VSn=d.yoD{h$E'J7P6Kv48$QcsVw(jv)dIw9#WylUof^'`/%P>op2.+;EYk }d NOBQA([|4QE'{} ^kCmd.qHgd83Vd?|aEnIq(cw}DrBe$'7S0C0{%PY=D>mO)'TU Z7~%#|MczP?'6@p>dZNE+%?uHwCpV2pHAVR9?V90>.^M-9cL2?VN'CZdk]>r_THK%e9fjnD.G:Me{" + "value": "ulSb,uaL+NJ6YcH>L2Qg)NB!+I45S 0[RKuPSa'U#X~bK)c7n)tad%;jSVU/l<[,lgl1}Pm9/Q=gy[A:5Mnj>tD 8@IJKDUpn+dS3{AK46c*s}]eBS0mJG@a_9+uq>P" }, { "disabled": false, @@ -4471,7 +4511,7 @@ }, "response": [ { - "id": "c95ba54d-b54c-419a-a41a-1d746fabb33a", + "id": "f2b6a283-478b-47d2-b70f-26a57aa6ca61", "name": "Returns a campaign object", "originalRequest": { "url": { @@ -4528,7 +4568,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cdabc28c-31f6-4c03-bef9-a01061a761dd", + "id": "6688d3d3-de39-480e-94a9-b8d7daa2b192", "name": "Error", "originalRequest": { "url": { @@ -4591,7 +4631,7 @@ } }, { - "id": "58a82d91-68ef-421d-a77d-6703aa3ab6c3", + "id": "698221d8-bbbe-4c12-820b-815f7ed95c5d", "name": "Delete", "request": { "name": "Delete", @@ -4629,7 +4669,7 @@ }, "response": [ { - "id": "90791d26-6d06-46b6-99bf-75353cb6dc39", + "id": "9a6f36fa-2de9-44f3-bc1e-97ded5d85234", "name": "Deleted the campaign.", "originalRequest": { "url": { @@ -4677,7 +4717,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ac92d6bf-2980-4ae2-b508-0173837ae8b5", + "id": "b382d1b4-376b-4dac-a85b-5dbef88e35e1", "name": "Error", "originalRequest": { "url": { @@ -4728,7 +4768,7 @@ "event": [] }, { - "id": "72535d04-7a14-487c-bd39-d4e4cae533f0", + "id": "3fa1823b-ae49-4c2d-82a4-f913c8f2349a", "name": "Send Campaign", "request": { "name": "Send Campaign", @@ -4767,7 +4807,7 @@ }, "response": [ { - "id": "3f9e0cd8-a15c-42d7-9347-a819b961c8a8", + "id": "c7805f14-1510-4422-9a34-dae721497a78", "name": "Returns a campaign object", "originalRequest": { "url": { @@ -4816,7 +4856,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d4e28449-d8d2-46c6-93fa-bfc25a10d6e9", + "id": "8e6172e2-4ada-47e5-bfc0-6a2c41e067e1", "name": "Error", "originalRequest": { "url": { @@ -4871,7 +4911,7 @@ "event": [] }, { - "id": "9d553205-0191-4389-8494-8f2c85134c31", + "id": "0eec3e6c-fe15-466c-9d39-1318af9592e6", "name": "Card Orders", "description": { "content": "The card orders endpoint allows you to easily create card orders for existing cards.\nThe API provides endpoints for creating card orders and listing card orders for a given card.\n
back to top
\n", @@ -4879,7 +4919,7 @@ }, "item": [ { - "id": "647f7beb-d184-4bd6-a4f2-5863b695a26d", + "id": "ce6ea47d-5711-46a3-b452-5cf4890e1038", "name": "Retrieve", "request": { "name": "Retrieve", @@ -4931,7 +4971,7 @@ }, "response": [ { - "id": "7599e946-8d05-4404-866a-5a7ea748b581", + "id": "e92764fc-dcf6-4c26-a8e1-f7cbc8f39a74", "name": "Returns the card orders associated with the given card id", "originalRequest": { "url": { @@ -4989,7 +5029,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aa7b74b8-b84f-4300-a719-c5644aed23e2", + "id": "3b985378-aa28-4d3a-b2ed-5a47cd5f4a45", "name": "Error", "originalRequest": { "url": { @@ -5050,7 +5090,7 @@ "event": [] }, { - "id": "92408dd3-9dd9-499c-ac1a-571ecad38752", + "id": "1aaf7f4d-d025-473c-9eec-2115fbeed593", "name": "Create", "request": { "name": "Create", @@ -5104,7 +5144,7 @@ }, "response": [ { - "id": "ac4e6cf0-9e11-4b33-8961-ab273eebb2da", + "id": "38659946-fd27-41ed-930f-2f59bea9ba23", "name": "Card order created successfully", "originalRequest": { "url": { @@ -5166,7 +5206,7 @@ "_postman_previewlanguage": "json" }, { - "id": "223b29de-360c-49e8-9731-dfed2bb078d3", + "id": "218a8a41-b0c3-476b-b0fd-93d39590eb68", "name": "Error", "originalRequest": { "url": { @@ -5237,7 +5277,7 @@ "event": [] }, { - "id": "bc028bb7-daad-4a69-b87e-49810bd1b2c6", + "id": "e7115b8f-cba1-4af0-b709-f845854b462d", "name": "Cards", "description": { "content": "The cards endpoint allows you to easily create cards that can later be affixed to Letters.\nThe API provides endpoints for creating cards, retrieving individual cards, creating card orders, and retrieving a list of cards.\n
back to top
\n", @@ -5245,7 +5285,7 @@ }, "item": [ { - "id": "74f5eb17-c616-4391-bb1d-306d4bc9b98f", + "id": "c6c9298c-d6b1-48c3-ac5e-f9190442857e", "name": "List", "request": { "name": "List", @@ -5305,7 +5345,7 @@ }, "response": [ { - "id": "a30c8838-efc1-4fce-af42-a3c5696ccce5", + "id": "1b83a8a4-b3a4-4bd3-a386-6ab95cd362ed", "name": "Returns a list of card objects", "originalRequest": { "url": { @@ -5365,7 +5405,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ace003a2-3ccb-4422-a689-f9759bd4057b", + "id": "ec10fe93-93d4-4c8a-a614-1ff0bcfe565c", "name": "Error", "originalRequest": { "url": { @@ -5428,7 +5468,7 @@ "event": [] }, { - "id": "c4c19823-0d48-41eb-a959-478a53b05c82", + "id": "e08277b9-7c6b-4e55-a54e-f04045190395", "name": "Create", "request": { "name": "Create", @@ -5486,7 +5526,7 @@ }, "response": [ { - "id": "fb6fd4aa-eb89-4dc7-8c39-8c46ecc31a8d", + "id": "92a9d8db-5cb8-423a-8262-17bd06333443", "name": "Card created successfully", "originalRequest": { "url": { @@ -5549,7 +5589,7 @@ "_postman_previewlanguage": "json" }, { - "id": "04f8bc7f-6753-42b6-80f0-36df0d81be73", + "id": "1723490d-eab7-4dbf-b210-3f2f8c8c4430", "name": "Error", "originalRequest": { "url": { @@ -5618,7 +5658,7 @@ } }, { - "id": "708576a2-993f-440c-b3fa-a4a565ffe439", + "id": "d085e95b-b18f-4d13-8569-403953b60c97", "name": "Retrieve", "request": { "name": "Retrieve", @@ -5656,7 +5696,7 @@ }, "response": [ { - "id": "a739db43-29d1-49d4-a457-7b9cff0006ae", + "id": "94c95df5-2e1b-4773-b709-d03afc7b0b22", "name": "Returns a card object", "originalRequest": { "url": { @@ -5704,7 +5744,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3e0afb2b-9609-4f8f-a837-0e467d89f3b7", + "id": "d3a2ff43-01cc-411d-aa2b-22f0a1193192", "name": "Error", "originalRequest": { "url": { @@ -5755,7 +5795,7 @@ "event": [] }, { - "id": "d13edb0f-08f5-4d8d-9726-462993c6d320", + "id": "443c7d93-b008-4e08-b354-7d1d0440836f", "name": "Update", "request": { "name": "Update", @@ -5819,7 +5859,7 @@ }, "response": [ { - "id": "c2ef3523-21dd-46f1-8e0f-acaf1f88bd15", + "id": "ca92a6a0-1b91-43e9-a7c0-0c5c7ac57a82", "name": "Returns a card object", "originalRequest": { "url": { @@ -5885,7 +5925,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9fc8626c-2e71-4849-9e03-332506b44bd0", + "id": "2a5b1e8d-40fe-4ce1-8bbc-7d6df5d834c2", "name": "Error", "originalRequest": { "url": { @@ -5957,7 +5997,7 @@ } }, { - "id": "ebc06ce9-16d4-43e0-a56c-d943e64678d5", + "id": "fc2f60fe-1bb4-4381-a929-c5f66b1d42b7", "name": "Delete", "request": { "name": "Delete", @@ -5995,7 +6035,7 @@ }, "response": [ { - "id": "63e9d37e-6001-4e0b-b833-79366e2ce778", + "id": "97b4c909-8ee8-4f66-b851-880088a73bf9", "name": "Deleted the card", "originalRequest": { "url": { @@ -6043,7 +6083,7 @@ "_postman_previewlanguage": "json" }, { - "id": "db1aed51-f289-49eb-9148-98d9cbfa1b6d", + "id": "9950a02c-980b-41a9-959d-027df3d9f489", "name": "Error", "originalRequest": { "url": { @@ -6097,7 +6137,7 @@ "event": [] }, { - "id": "0fdf95a3-e531-4c61-8856-e2b66914855d", + "id": "5e16156a-fbdf-44b5-bf25-ccfe76d9d1d7", "name": "Checks", "description": { "content": "Checks allow you to send payments via physical checks. The API provides endpoints\nfor creating checks, retrieving individual checks, canceling checks, and retrieving a list of checks.\n
back to top
\n", @@ -6105,7 +6145,7 @@ }, "item": [ { - "id": "e84b509d-790d-4f69-be00-2c7eff4da93b", + "id": "66f013a3-4124-4b0b-b9a3-3a97b3a38ed0", "name": "List", "request": { "name": "List", @@ -6153,7 +6193,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -6201,7 +6259,7 @@ }, "response": [ { - "id": "22a4bc70-f666-4226-852c-2990c7eab175", + "id": "4c3620cd-12fb-4059-85b0-f55b7664cca2", "name": "A dictionary with a data property that contains an array of up to `limit` checks. Each entry in the array is a separate check. The previous and next page of checks can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more checks are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -6233,15 +6291,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -6293,7 +6347,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b2145d84-a8b8-4a0c-bdfc-1ca515891762", + "id": "2ea35fe7-07e3-41e7-b42c-82654f6fbc68", "name": "Error", "originalRequest": { "url": { @@ -6325,15 +6379,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -6388,7 +6438,7 @@ "event": [] }, { - "id": "88259cdc-d213-490a-aee1-ebbf3d7c57ce", + "id": "21bece65-3764-450b-9ac4-f29b0f3076b6", "name": "Create", "request": { "name": "Create", @@ -6479,7 +6529,7 @@ }, "response": [ { - "id": "47fce6b5-3538-412d-a3ea-205148ae0661", + "id": "6dbacbc5-2be0-4df6-937f-a56fc4dce47e", "name": "Returns a check object", "originalRequest": { "url": { @@ -6696,7 +6746,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e1aaadc2-c1f7-4e6f-b9e2-7030bbe28e90", + "id": "2a02fbd9-8052-4458-9c54-e541467bec4b", "name": "Error", "originalRequest": { "url": { @@ -6901,7 +6951,7 @@ } }, { - "id": "30fd9ec5-39a3-45c8-ad4b-5cc59ca90bc6", + "id": "46e6314c-2153-4164-8ac0-8ab4ea31fac7", "name": "Retrieve", "request": { "name": "Retrieve", @@ -6939,7 +6989,7 @@ }, "response": [ { - "id": "724d32e0-05c4-452e-b371-166ae8c80a3a", + "id": "e49be6b7-2175-45b9-993d-2f2fab56b79b", "name": "Returns a check object", "originalRequest": { "url": { @@ -6987,7 +7037,7 @@ "_postman_previewlanguage": "json" }, { - "id": "16cddd2c-24ca-4b66-8763-43730157fd3c", + "id": "4c9d4ead-334d-4dae-acf3-cdd018361ffe", "name": "Error", "originalRequest": { "url": { @@ -7038,7 +7088,7 @@ "event": [] }, { - "id": "73d841ef-78e8-430e-a306-b974895cf083", + "id": "70f6f2fd-c9df-4b9d-bbce-31d82a44dbdb", "name": "Cancel", "request": { "name": "Cancel", @@ -7076,7 +7126,7 @@ }, "response": [ { - "id": "d1b66095-28e1-4764-8d54-f27c251bd890", + "id": "cfaad8b5-eac7-4460-96e3-4985fc02a7e3", "name": "Deleted", "originalRequest": { "url": { @@ -7124,7 +7174,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bff58f36-dc3f-4f09-988f-fbc34eedfb0e", + "id": "aee4d677-984a-4c2f-b72a-39ec2dff7e41", "name": "Error", "originalRequest": { "url": { @@ -7178,7 +7228,7 @@ "event": [] }, { - "id": "07124dea-3b1f-41da-a53f-20d21a5408ac", + "id": "27aad623-bb94-4fa2-b2a6-23f28eabe11b", "name": "Creatives", "description": { "content": "The creatives endpoint allows you to create and view creatives. Creatives are used to create\nreusable letter and postcard templates. The API provides endpoints for creating creatives, updating creatives,\nretrieving individual creatives, and deleting creatives.\n", @@ -7186,7 +7236,7 @@ }, "item": [ { - "id": "96b549e3-08a5-4c17-8c0c-428f9835c8c8", + "id": "6b048418-0d64-4015-81dd-65658bf86122", "name": "Create", "request": { "name": "Create", @@ -7280,7 +7330,7 @@ }, "response": [ { - "id": "c92e93bd-cbeb-4fcb-a485-3559303cd15d", + "id": "25acf668-ee0f-4c01-bca5-f0493212b770", "name": "Creative created successfully", "originalRequest": { "url": { @@ -7344,7 +7394,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a088447a-892a-4cdc-8a93-fad37ba1221b", + "id": "09294242-2ae1-4e80-8243-e346d1fd32d9", "name": "Error", "originalRequest": { "url": { @@ -7414,7 +7464,7 @@ } }, { - "id": "3e6688ca-6777-4056-9eae-3984e8776d16", + "id": "8e0c88b3-a395-439a-a659-10b4d9dc53ab", "name": "Retrieve", "request": { "name": "Retrieve", @@ -7452,7 +7502,7 @@ }, "response": [ { - "id": "754c82cc-9a32-45ff-af05-76d7950f63d8", + "id": "f8e9960c-4580-4f27-96c1-5284d219c85f", "name": "Returns a creative object", "originalRequest": { "url": { @@ -7500,7 +7550,7 @@ "_postman_previewlanguage": "json" }, { - "id": "776c9888-153e-4f31-925e-7432459d95ad", + "id": "01122074-06c8-4841-a3e8-4a14dea2fec7", "name": "Error", "originalRequest": { "url": { @@ -7551,7 +7601,7 @@ "event": [] }, { - "id": "b2f386ed-a944-41c1-aae1-30179f9acf88", + "id": "40c07f49-1313-44a4-be95-ff5580891229", "name": "Update", "request": { "name": "Update", @@ -7606,14 +7656,14 @@ { "disabled": false, "key": "metadata", - "value": "1_ D#1,r)_mkI*85$}6iVX*IO.OO./2Ok$TdffM7v[7- mku|%qCQ.TvW}lptBbVk'X;>qs20Pd dV1E=,IG~VIj[Vl.1~&5@!! 2zW52qE~eR9SGi]0UUtRLdmXK3c-7T`A?AF+SN~gdmE2pd4?FO!^.FHKS56m6`[_9*>$DBxiXh'e4]x}5GXzk-8$W8L>0ygLTH8nF_nX$J>^f##x]kj]uVY0bd.>c+tH+8*@OaybbD4JqFn2Z]inbm#~mn`37@~_&NF$}e.,|P@PA]okyL~YYEStDf&S(8Ak]/[@+B!HFsoCiU$:'Dy)I~V+O|j{opOI/ doMkYFb_4fbo+3LEfZd{{&Nn'\n \n ATTRIBUTE\n DESCRIPTION\n \n \n code\n A consistent machine-keyable string identifying the error\n \n \n status_code\n A conventional HTTP status code\n \n \n message\n A human-readable, subject-to-change message with more details about the error\n \n\n\n### HTTP Status Code Summary\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
STATUS_CODECODEMESSAGE
200SUCCESSSuccessful API request
401UNAUTHORIZEDAuthorization error with your API key or account
403FORBIDDENForbidden error with your API key or account
404NOT FOUNDThe requested item does not exist
422BAD REQUESTThe query or body parameters did not pass validation
429TOO MANY REQUESTSToo many requests have been sent with an API key in a given amount of time
500SERVER ERRORAn internal server error occurred, please contact support@lob.com
\n\n### Error Codes - Generic\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
STATUS_CODECODEMESSAGE
422BAD_REQUESTAn invalid request was made. See error message for details.
409/422CONFLICTThis operation would leave data in a conflicted state.
403FEATURE_LIMIT_REACHEDThe account has reached its resource limit and requires upgrading to add more.
500INTERNAL_SERVER_ERRORAn error has occured on Lob's servers. Please try request again.
422INVALIDAn invalid request was made. See error message for details.
422NOT_DELETABLEAn attempt was made to delete a resource, but the resource cannot be deleted.
404NOT_FOUNDThe requested resource was not found.
408REQUEST_TIMEOUTThe request took too long. Please try again.
503SERVICE_UNAVAILABLEThe Lob servers are temporarily unavailable. Please try again.
404UNRECOGNIZED_ENDPOINTThe requested endpoint doesn't exist.
422UNSUPPORTED_LOB_VERSIONAn unsupported Lob API version was requested.
\n\n### Error Codes - Authentication\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
STATUS_CODECODEMESSAGE
401EMAIL_REQUIREDAccount must have a verified email address before creating live resources.
401UNAUTHORIZEDThe request isn't authorized.
401UNAUTHORIZED_TOKENToken isn't authorized.
401/403INVALID_API_KEYThe API key is invalid.
403PUBLISHABLE_KEY_NOT_ALLOWEDThe requested operation needs a secret key, not a publishable key. See [API Keys](#tag/API-Keys) for more information.
429RATE_LIMIT_EXCEEDEDRequests were sent too quickly and must be slowed down.
\n\n ### Error Codes - Advanced\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
STATUS_CODECODEMESSAGE
401PAYMENT_METHOD_UNVERIFIEDYou must have a verified bank account or credit card to submit live requests.
404DELETED_BANK_ACCOUNTChecks cannot be created with a deleted bank account.
422ADDRESS_LENGTH_EXCEEDS_LIMITThe sum of to.address_line1 and to.address_line2 cannot surpass 50 characters.
422BANK_ACCOUNT_ALREADY_VERIFIEDThe bank account has already been verified.
422BANK_ERRORThere's an issue with the bank account.
403BILLING_ADDRESS_REQUIREDIn order to create a live mail piece, your account needs to set up a billing address.
422CUSTOM_ENVELOPE_INVENTORY_DEPLETEDCustom envelope inventory is depleted, and more will need to be ordered.
422FAILED_DELIVERABILITY_STRICTNESSThe to address doesn't meet strictness requirements.\n See Account Settings to configure strictness.
422FILE_PAGES_BELOW_MINNot enough pages.
422FILE_PAGES_EXCEED_MAXToo many pages.
422FILE_SIZE_EXCEEDS_LIMITThe file size is too large. See description for details.
422FOREIGN_RETURN_ADDRESSThe 'from' address must be a US address.
422INCONSISTENT_PAGE_DIMENSIONSAll pages of the input file must have the same dimensions.
422INVALID_BANK_ACCOUNTThe provided bank routing number is invalid.
422INVALID_BANK_ACCOUNT_VERIFICATIONVerification amounts do not match.
422INVALID_CHECK_INTERNATIONALChecks cannot be sent internationally.
422INVALID_COUNTRY_COVIDThe postal service in the specified country is currently unable to process the request due to COVID-19 restrictions.
422INVALID_FILEThe file is invalid.
422INVALID_FILE_DIMENSIONSFile dimensions are incorrect for the selected mail type.
422INVALID_FILE_DOWNLOAD_TIMEFile download from remote server took too long.
422INVALID_FILE_URLThe file URL when creating a resource is invalid.
422INVALID_IMAGE_DPIDPI must be at least 300.
422INVALID_INTERNATIONAL_FEATUREThe specified product cannot be sent to the destination.
422INVALID_PERFORATION_RETURN_ENVELOPEBoth `return_envelope` and `perforation` must be used together.
422INVALID_TEMPLATE_HTMLThe provided HTML is invalid.
422MAIL_USE_TYPE_CAN_NOT_BE_NULL`use_type` must be one of \"marketing\" or \"operational\". Alternatively, an admin can set the account default use type in Account Settings.
422MERGE_VARIABLE_REQUIREDA required merge variable is missing.
422MERGE_VARIABLE_WHITESPACEMerge variable names cannot contain whitespace.
422PDF_ENCRYPTEDAn encrypted PDF was provided.
422SPECIAL_CHARACTERS_RESTRICTEDCannot use special characters for merge variable names.
422UNEMBEDDED_FONTSThe provided PDF contains non-standard unembedded fonts. See description for details.
\n
back to top
\n", @@ -7746,7 +7796,7 @@ "event": [] }, { - "id": "afc036db-660c-4d6a-9ab5-5fa7d6c8d33b", + "id": "db44c546-4d8d-4c86-842a-30344ae06778", "name": "Events", "description": { "content": "When various notable things happen within the Lob architecture, Events will be created. To get these events sent to your server\nautomatically when they occur, you can set up [Webhooks](#tag/Webhooks).\n\n

Postcards

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
postcard.createdfalseA postcard is successfully created (Lob returns a 200 status code).
postcard.rejectedfalseA postcard was not successfully created (Usually happens when one or more postcards fail the creation step during a batch request)
postcard.rendered_pdffalseA postcard's PDF proof is successfully rendered.
postcard.rendered_thumbnailsfalseA postcard's thumbnails are successfully rendered.
postcard.deletedfalseA postcard is successfully canceled.
postcard.mailedtrueA postcard receives a \"Mailed\" tracking event. Only enabled for certain Print & Mail Editions.
postcard.in_transittrueA postcard receives an \"In Transit\" tracking event.
postcard.in_local_areatrueA postcard receives an \"In Local Area\" tracking event.
postcard.processed_for_deliverytrueA postcard receives a \"Processed for Delivery\" tracking event.
postcard.deliveredfalseA postcard receives a \"Delivered\" tracking event.
postcard.failedfalseA postcard receives a \"Failed\" rendering error or tracking event.
postcard.re-routedtrueA postcard receives a \"Re-Routed\" tracking event.
postcard.returned_to_sendertrueA postcard receives a \"Returned to Sender\" tracking event.
postcard.international_exittrueA postcard receives a \"International Exit\" tracking event.
postcard.viewedfalseA postcard QR code or URL was scanned or viewed by the recipient.
\n\n

Self Mailers

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
self_mailer.createdfalseA self_mailer is successfully created (Lob returns a 200 status code).
self_mailer.rejectedfalseA self_mailer was not successfully created (Usually happens when one or more self_mailers fail the creation step during a batch request)
self_mailer.rendered_pdffalseA self_mailer's PDF proof is successfully rendered.
self_mailer.rendered_thumbnailsfalseA self_mailer's thumbnails are successfully rendered.
self_mailer.deletedfalseA self_mailer is successfully canceled.
self_mailer.mailedtrueA self_mailer receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions.
self_mailer.in_transittrueA self_mailer receives an \"In Transit\" tracking event.
self_mailer.in_local_areatrueA self_mailer receives an \"In Local Area\" tracking event.
self_mailer.processed_for_deliverytrueA self_mailer receives a \"Processed for Delivery\" tracking event.
self_mailer.deliveredtrueA self_mailer receives an \"Delivered\" tracking event.
self_mailer.failedfalseA self_mailer receives an \"Failed\" rendering error or tracking event.
self_mailer.re-routedtrueA self_mailer receives a \"Re-Routed\" tracking event.
self_mailer.returned_to_sendertrueA self_mailer receives a \"Returned to Sender\" tracking event.
self_mailer.international_exittrueA self_mailer receives an \"International Exit\" tracking event.
self_mailer.viewedfalseA self_mailer's QR code or URL was scanned or viewed by the recipient.
\n\n

Letters

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
letter.createdfalseA letter is successfully created (Lob returns a 200 status code).
letter.rejectedfalseA letter was not successfully created (Usually happens when one or more letters fail the creation step during a batch request)
letter.rendered_pdffalseA letter's PDF proof is successfully rendered.
letter.rendered_thumbnailsfalseA letter's thumbnails are successfully rendered.
letter.deletedfalseA letter is successfully canceled.
letter.mailedtrueA letter receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions.
letter.in_transittrueA letter receives an \"In Transit\" tracking event.
letter.in_local_areatrueA letter receives an \"In Local Area\" tracking event.
letter.processed_for_deliverytrueA letter receives a \"Processed for Delivery\" tracking event.
letter.deliveredtrueA letter receives a \"Delivered\" tracking event.
letter.failedfalseA letter receives a \"Failed\" rendering error or tracking event.
letter.re-routedtrueA letter receives a \"Re-Routed\" tracking event.
letter.returned_to_sendertrueA letter receives a \"Returned to Sender\" tracking event.
letter.international_exittrueA letter receives a \"International Exit\" tracking event.
letter.viewedfalseA letter's QR code or URL was scanned or viewed by the recipient.
letter.certified.mailedtrueA certified letter receives a \"Mailed\" tracking event. Only enabled for certain\n Print & Mail Editions.
letter.certified.in_transittrueA certified letter receives an \"In Transit\" tracking event.
letter.certified.in_local_areatrueA certified letter receives an \"In Transit\" tracking event.
letter.certified.processed_for_deliverytrueA certified letter receives a \"Processed for Delivery\" tracking event.
letter.certified.re-routedtrueA certified letter receives a \"Re-Routed\" tracking event.
letter.certified.returned_to_sendertrueA certified letter receives a \"Returned to Sender\" tracking event.
letter.certified.deliveredtrueA certified letter receives a \"Delivered\" tracking event.
letter.certified.pickup_availabletrueA certified letter receives a \"Pickup Available\" tracking event.
letter.certified.issuetrueA certified letter receives an \"Issue\" tracking event.
letter.return_envelope.createdfalseA return envelope is created (occurs simultaneously with letter creation).
letter.return_envelope.in_transittrueA return envelope receives an \"In Transit\" tracking event.
letter.return_envelope.in_local_areatrueA return envelope receives an \"In Local Area\" tracking event.
letter.return_envelope.processed_for_deliverytrueA return envelope receives a \"Processed for Delivery\" tracking event.
letter.return_envelope.re-routedtrueA return envelope receives a \"Re-Routed\" tracking event.
letter.return_envelope.returned_to_sendertrueA return envelope receives a \"Returned to Sender\" tracking event.
\n\n

Checks

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
check.createdfalseA check is successfully created (Lob returns a 200 status code).
check.rejectedfalseA check was not successfully created (Usually happens when one or more checks fail the creation step during a batch request)
check.rendered_pdffalseA check's PDF proof is successfully rendered.
check.rendered_thumbnailsfalseA check's thumbnails are successfully rendered.
check.deletedfalseA check is successfully canceled.
check.mailedtrueA check receives a \"Mailed\" tracking event. Only enabled for certain Print & Mail Editions.
check.in_transittrueA check receives an \"In Transit\" tracking event.
check.in_local_areatrueA check receives an \"In Local Area\" tracking event.
check.processed_for_deliverytrueA check receives a \"Processed for Delivery\" tracking event.
check.deliveredtrueA check receives a \"Delivered\" tracking event.
check.failedfalseA check receives a \"Failed\" rendering error or tracking event.
check.re-routedtrueA check receives a \"Re-Routed\" tracking event.
check.returned_to_sendertrueA check receives a \"Returned to Sender\" tracking event.
\n\n

Addresses

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
address.createdfalseAn address is successfully created (Lob returns a 200 status code).
address.deletedfalseAn address is successfully deleted.
\n\n

Bank Accounts

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
bank_account.createdfalseA bank account is successfully created (Lob returns a 200 status code).
bank_account.deletedfalseA bank account is successfully deleted.
bank_account.verifiedfalseA bank account is successfully verified.
\n
back to top
\n", @@ -7756,7 +7806,7 @@ "event": [] }, { - "id": "3b9791bc-7c38-4e8f-87e0-380d6882a8c2", + "id": "d25d9920-0389-467e-a0ce-0f5ef7e8edd4", "name": "Getting Started", "description": { "content": "### 1. Get Setup\n* Create an account at Lob.com\n* Obtain your API keys in the Lob dashboard settings\n* You'll use the format, `test_*.` for your Test API key and `live_*.` for your Live API key.\n\n### 2. Explore\n* Try out in Postman:\n
\n Run in Postman\n
\n\n* Launch your terminal and copy/paste a CURL command.\n```bash\ncurl https://api.lob.com/v1/addresses \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n```\n* Download a [Lob SDK](#tag/SDKs-and-Tools) into your favorite IDE (integrated development environment)\n\n### 3. Learn more\nTry our quick start (TypeScript, Python, PHP, Java or Ruby):\n* Send your first Postcards\n\nUse Case guides\n* Mass Deletion Setup\n* NCOA Restrictions\n* Override Cancellation Window\n* Visibility of Address Changes\n* Ingesting Tracking Events with Webhooks\n
back to top
\n", @@ -7766,7 +7816,7 @@ "event": [] }, { - "id": "a1a35636-5644-49d8-9b22-803e0356fa15", + "id": "a361d89e-515d-46a4-9dd8-70a0793561ed", "name": "Identity Validation", "description": { "content": "Validates whether a given name is associated with an address.\n
back to top
\n", @@ -7774,7 +7824,7 @@ }, "item": [ { - "id": "5f1369ed-f672-4f94-9937-032036e3a926", + "id": "9fab5e0f-aaa0-4957-b1b4-8aee027edcd0", "name": "Identity Validation", "request": { "name": "Identity Validation", @@ -7847,7 +7897,7 @@ }, "response": [ { - "id": "f938207e-e552-4a9f-bf7d-d519f7ea254f", + "id": "34d855c2-d298-443d-b984-baff6e825fb5", "name": "Returns the likelihood a given name is associated with an address.", "originalRequest": { "url": { @@ -7938,7 +7988,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67b7c292-84e9-4c07-8e3f-cc93b607e1d6", + "id": "61b0f4dd-452b-4a48-a794-a7c24557b9c7", "name": "Error", "originalRequest": { "url": { @@ -8020,7 +8070,7 @@ "event": [] }, { - "id": "83b72abc-a093-4c50-82c5-c170decf9420", + "id": "13d9f4ef-4f30-42de-b959-24e12c8c7e12", "name": "Informed Delivery Campaign", "description": { "content": "The Informed Delivery campaigns API allows you to create and view Informed Delivery campaigns.\n
back to top
\n", @@ -8028,7 +8078,7 @@ }, "item": [ { - "id": "05778141-ff45-4dee-9459-1097b35d1980", + "id": "5d5a2c46-3b51-46a9-b59e-237ba4b1da42", "name": "List", "request": { "name": "List", @@ -8057,7 +8107,7 @@ }, "response": [ { - "id": "6284f421-d235-41a6-b4b6-8d14102c471d", + "id": "79894982-4ba8-40de-8471-7469968afe93", "name": "A dictionary with a data property that contains an array of up to `limit` Informed Delivery campaigns. Each entry in the array is a separate campaign. The previous and next page of campaigns can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively. If no more campaigns are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -8099,7 +8149,7 @@ "event": [] }, { - "id": "67a93f42-f19b-439d-9b1d-59b36a41c79c", + "id": "f88d21cf-58b6-45b2-9550-dcbab706db67", "name": "Create", "request": { "name": "Create", @@ -8152,7 +8202,7 @@ }, { "key": "quantity", - "value": "true", + "value": "-64794539.948833704", "type": "text", "description": "undefined" } @@ -8161,7 +8211,7 @@ }, "response": [ { - "id": "a9cd4a54-0b87-4989-a904-d745b862ab76", + "id": "91b46972-1220-4338-ad8b-21675b67e8c3", "name": "Creative created successfully", "originalRequest": { "url": { @@ -8221,7 +8271,7 @@ "type": "text/plain" }, "key": "quantity", - "value": "false", + "value": "35953904", "type": "text" } ] @@ -8240,7 +8290,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2e420d9e-ab1d-4564-a87a-933c32a97f9f", + "id": "4698f86c-960a-4435-8e9a-853813e05f04", "name": "Error", "originalRequest": { "url": { @@ -8300,7 +8350,7 @@ "type": "text/plain" }, "key": "quantity", - "value": "false", + "value": "35953904", "type": "text" } ] @@ -8325,7 +8375,7 @@ } }, { - "id": "d3723d5b-9297-454e-89ea-0e3cae318e1a", + "id": "e6327c91-438d-4ba4-9ac2-43a31a9cd1b8", "name": "Retrieve", "request": { "name": "Retrieve", @@ -8363,7 +8413,7 @@ }, "response": [ { - "id": "c9d4eadc-8a15-430a-95e9-1dfa211461f3", + "id": "507377b5-6641-4eb1-a568-ce1f1f3a30fd", "name": "Returns a informed delivery campaign object", "originalRequest": { "url": { @@ -8411,7 +8461,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ebee50e4-32f1-41db-8f01-7d72c7c842fe", + "id": "58a8ca4f-7b5e-4ea0-9b2a-02b9b702865b", "name": "Error", "originalRequest": { "url": { @@ -8462,7 +8512,7 @@ "event": [] }, { - "id": "af544189-4e3e-41f5-bfea-e1f4d1936870", + "id": "95a3421a-1fe0-41e3-951f-7b7cefd1f865", "name": "Update", "request": { "name": "Update", @@ -8527,7 +8577,7 @@ }, "response": [ { - "id": "3b2a11fe-8089-483d-9555-9500a1616de2", + "id": "dbad2b93-f73a-4aa3-9c5e-6c94aea315ca", "name": "Returns an Informed Delivery campaign object", "originalRequest": { "url": { @@ -8606,7 +8656,7 @@ "_postman_previewlanguage": "json" }, { - "id": "980f67df-5dcb-46f6-8ef8-96017fa15f2c", + "id": "85316eb2-6975-4fac-b9d4-93e6769a22ad", "name": "Error", "originalRequest": { "url": { @@ -8685,7 +8735,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bd223c6b-01c2-4525-8aef-75a8d9d9e386", + "id": "f5aea155-4ef6-4b2b-a929-b16c1efe5e0b", "name": "Error", "originalRequest": { "url": { @@ -8773,7 +8823,7 @@ "event": [] }, { - "id": "70f737c8-cbd3-4c86-a3a4-e1b45acf3bf4", + "id": "b980ef3a-cf34-4929-9f90-36f2796bbbed", "name": "Intl Verifications", "description": { "content": "Address verification for non-US addresses\n
\n
back to top
\n\n## Intl Verifications Test Env\n\nWhen verifying international addresses, you'll likely want to test against\na wide array of addresses to ensure you're handling responses correctly.\nWith your test API key, requests that use specific values for `primary_line`\nlet you explore the responses to many types of addresses:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
DELIVERABILITY OF SAMPLE RESPONSESET primary_line TO
deliverabledeliverable
deliverable_missing_infodeliverable missing info
undeliverableundeliverable
no_matchno match
\n\nSee the `test` request & response examples under [Intl Verification Examples](#operation/intl_verification) within the\n\"Verify an international address section\" in Intl Verifications.\n\nYou can rely on the response from these examples generally matching the response\nyou'd see in the live environment with an address of that type (excluding the `recipient` field).\n\nThe test API key does not perform any verification, automatic correction, or standardization\nfor addresses. If you wish to try these features out, use our live demo\nor the free plan (see our pricing for details).\n
back to top
\n", @@ -8781,7 +8831,7 @@ }, "item": [ { - "id": "777e3b70-2fdc-4c30-9128-dafb8a8b8e20", + "id": "e7b08d7e-ce73-4f0d-b022-8bad6d56f15c", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -8826,7 +8876,7 @@ }, "response": [ { - "id": "5935bba8-cd10-44e6-b109-77d10370d59c", + "id": "15d89837-99c4-4f7c-a937-6f079bf825c8", "name": "Returns an array of international verification objects.", "originalRequest": { "url": { @@ -8897,7 +8947,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2bbf48b4-d462-45f0-a998-1a18414d188c", + "id": "20c6c317-49a3-42c5-b72e-05b9c6d831b0", "name": "Error", "originalRequest": { "url": { @@ -8956,7 +9006,7 @@ } }, { - "id": "e461d88e-2897-4d26-a1a9-a3f3c11fde36", + "id": "f7a8677f-cd55-4c87-9074-cedbc39ea50b", "name": "Single Verify", "request": { "name": "Single Verify", @@ -9035,7 +9085,7 @@ }, "response": [ { - "id": "d6e59c88-61a3-4127-80d1-510af5063159", + "id": "aeb164b0-745f-4540-adf2-5f5344336567", "name": "Returns an international verification object.", "originalRequest": { "url": { @@ -9137,7 +9187,7 @@ "_postman_previewlanguage": "json" }, { - "id": "de25b3e2-6d88-48b1-8b82-d78052a4f57f", + "id": "20af066a-1ffa-444b-9360-4e02191bd71e", "name": "Error", "originalRequest": { "url": { @@ -9230,7 +9280,7 @@ "event": [] }, { - "id": "0dbe016f-f97b-4af1-9f4e-83b4d634189f", + "id": "0376f8be-916e-4155-ae20-23331744c76d", "name": "Introduction", "description": { "content": "Lob’s Print & Mail and Address Verification APIs help companies transform outdated,\nmanual print-and-mail processes; save 1,000s of hours in processing time by sending mail much more\nquickly; and increase ROI on offline communications.\n\nAutomate direct mail by triggering on-demand postcards, letters, and checks directly from your\nCRM or customer data systems.\n\nAddress Verification corrects, standardizes, and cleanses address data for assured delivery with\ninstant verification across 240+ countries and territories.\n\nLob's print delivery network eliminates the hassle of vendor management with automated\nproduction and postage across a global network of vetted commercial printers.\n\nTracking & Analytics gives you complete visibility of production and delivery for each piece of\nmail you send to meet compliance requirements and measure campaign performance.\n", @@ -9240,7 +9290,7 @@ "event": [] }, { - "id": "b6987305-5d74-4a96-989d-12f7c9b956e2", + "id": "54b18966-cda2-40e9-bc22-4ffb56888d8c", "name": "Letters", "description": { "content": "The letters endpoint allows you to easily print and mail letters. The API provides endpoints for\ncreating letters, retrieving individual letters, canceling letters, and retrieving a list of letters.\n
back to top
\n", @@ -9248,7 +9298,7 @@ }, "item": [ { - "id": "645b57b8-02f6-4b9b-a984-5ecd7e584ab7", + "id": "a9eba87a-ba9f-422e-b8e3-9c9bad5b385e", "name": "Retrieve", "request": { "name": "Retrieve", @@ -9286,7 +9336,7 @@ }, "response": [ { - "id": "7786b6aa-a187-42a6-bf52-5a2355b2ee38", + "id": "5b80f0db-4b7f-4f89-b819-573f7b40edda", "name": "Returns a letter object", "originalRequest": { "url": { @@ -9334,7 +9384,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e2663816-b0c8-4467-b4d5-a4fc93153257", + "id": "0ca23410-c0aa-48d2-9ed8-8f0e05670ac8", "name": "Error", "originalRequest": { "url": { @@ -9385,7 +9435,7 @@ "event": [] }, { - "id": "ca972a2a-9626-4acf-b8f1-cb17352378ba", + "id": "bb069795-3f4f-4136-93e9-f53dc4af544d", "name": "Cancel", "request": { "name": "Cancel", @@ -9423,7 +9473,7 @@ }, "response": [ { - "id": "5b53d7d4-b259-430c-ba67-73fe6663b9a4", + "id": "5f936afb-5873-4737-abf2-3b8c3e153f12", "name": "Deleted", "originalRequest": { "url": { @@ -9471,7 +9521,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3ae35bad-41a2-499b-8b0f-ba167544326c", + "id": "164503d2-b589-4a1c-b814-b6d742cfc9aa", "name": "Error", "originalRequest": { "url": { @@ -9522,7 +9572,7 @@ "event": [] }, { - "id": "b109a908-44d4-4043-8725-e5e035087563", + "id": "d1e0219f-6ffd-48dc-a560-bca231405612", "name": "List", "request": { "name": "List", @@ -9570,7 +9620,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -9630,7 +9698,7 @@ }, "response": [ { - "id": "5e4a4722-1ccb-49dd-a253-1f1a56d348ae", + "id": "3d0f1a63-518f-4ded-83e2-c30df0daa3cc", "name": "A dictionary with a data property that contains an array of up to `limit` letters. Each entry in the array is a separate letter. The previous and next page of letters can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively. If no more letters are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -9662,15 +9730,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -9730,7 +9794,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5c0db47f-1326-4426-8a4c-fb6b1acbb93c", + "id": "286d9740-2599-441b-8d32-c7f2ee671292", "name": "Error", "originalRequest": { "url": { @@ -9762,15 +9826,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -9833,7 +9893,7 @@ "event": [] }, { - "id": "83c957e2-d193-4d2f-b86b-5f1773370aea", + "id": "5ed3e0d2-d7a5-444a-9704-1a4d669c1cbb", "name": "Create", "request": { "name": "Create", @@ -10030,7 +10090,7 @@ }, "response": [ { - "id": "fd396599-28ce-4825-a005-a64c4ca62ed4", + "id": "cb7e987a-0ce1-437d-bf24-8aa2089e0ffc", "name": "Returns a letter object", "originalRequest": { "url": { @@ -10298,7 +10358,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2b478328-00a8-45ab-991f-57254cd3d87e", + "id": "fd5ca1af-d695-4203-9e49-a91871c60ad8", "name": "Error", "originalRequest": { "url": { @@ -10557,7 +10617,7 @@ "event": [] }, { - "id": "51cd5cb8-09a0-439a-a47d-344eb6e0b681", + "id": "e5be0769-b85a-4904-a3b0-f4fd3b37a852", "name": "Manage Mail", "description": { "content": "## Cancellation Windows\n\nBy default, all new accounts have a 5 minute cancellation window for postcards,\nself mailers, letters, and checks. Within that timeframe, you can cancel\nmailings from production, free of charge. Once the window has passed for a\npostcard, self mailer, letter, or check, the mailing is no longer cancelable.\nIn addition, certain customers can customize their cancellation windows by\nproduct in their Dashboard Settings. Upgrade to\nthe appropriate Print & Mail Edition\nto automatically gain access to this ability. For more details on this feature,\ncheck out our Cancellation Guide.\n\nIf you schedule a postcard, self mailer, letter, or check for up to 180 days\nin the future by supplying the `send_date` parameter, that will override any\ncancellation window you may have for that product.\n
\n
back to top
\n\n## Scheduled Mailings\n\nPostcards, self mailers, letters, and checks can be scheduled to be sent up\nto 180 days in advance. You can use this feature to:\n- Create automated drip campaigns (e.g. send a postcard at 15, 30, and 60\ndays)\n- Schedule recurring sends\n- Plan your mailing schedule ahead of time\n\nUp until the time a mailing is scheduled for, it can also be canceled.\nIf you use this feature in conjunction with [a cancellation window](\nindex.html#section/Cancellation-Windows), the `send_date` parameter will always\ntake precedence.\n\nFor implementation details, see documentation below for each respective\nendpoint. For more help, see our Scheduled Mailings Guide.\n\nThis feature is exclusive to certain customers. Upgrade to the appropriate\nPrint & Mail Edition to\ngain access.\n\n### Example Create Request using Send Date\n\n```bash\n curl https://api.lob.com/v1/postcards \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -d \"description=Demo Future Postcard\" \\\n -d \"to=adr_bae820679f3f536b\" \\\n -d \"from=adr_210a8d4b0b76d77b\" \\\n -d \"front=tmpl_b846a20859ae11a\" \\\n -d \"back=tmpl_01b0d396a10c268\" \\\n -d \"merge_variables[name]=Harry\" \\\n -d \"send_date=2021-07-26\"\n```\n
back to top
\n", @@ -10567,7 +10627,7 @@ "event": [] }, { - "id": "8c724b6b-495d-4924-9eef-bf2a8fd260d3", + "id": "16a79fbb-581a-46b9-97b2-6db5fe3167af", "name": "National Change of Address", "description": { "content": "National Change of Address Linkage (NCOALink) is a service offered by the USPS, which allows individuals\nor businesses who have recently moved to have any mail forwarded from their previous address\nto their new address.\n\nAs a CASS-certified Address Verification Provider, Lob also offers NCOALink\nfunctionality to our Print & Mail customers. With the Lob NCOALink feature enabled, Postcards,\nLetters, Checks and Addresses can automatically be corrected to reflect an individual's or business's\nnew address in the case that they have moved (only if they have registered for NCOALink with the USPS).\n\nDue to privacy concerns and USPS constraints, for customers with NCOALink enabled, our API responses\nfor a limited set of endpoints differ slightly in the case when an address has been changed through NCOALink.\n\n**NOTE**: This feature is exclusive to certain customers. Upgrade to the appropriate Print & Mail Editions to gain access.\n\nFor more information, see our NCOALink guide.\n
\n
back to top
\n\n## NCOALink Live Environment\nThough there are no changes to API requests, there are significant changes to our API responses, but\nonly in the event that an address has been changed through NCOALink. If an address has not been changed\nthrough NCOALink, the response would be identical to our standard responses, except the addition of a\n`recipient_moved` field, which is `false` for unchanged addresses.\n\nIf an address has been changed through NCOALink, we are required to suppress the following response\nfields for that address:\n- `address_line1`\n- `address_line2`\n- The +4 portion of the ZIP+4 (5-digit ZIP code will still be present)\n\nSee the `ncoa_us_live` example under [Response samples](#operation/address_create) within the \"Create an Address\" section in Addresses\n
\n
back to top
\n\n## NCOALink Test Environment\n\nIn addition to sending live requests, you may also want to simulate what an NCOALink response might\nlook like so that you can ensure your application behaves as expected. The behavior of NCOALink in\nLob's Test Environment is very similar to our [US Verifications Test Mode](#section/US-Verifications-Test-Env).\n\nTo simulate an NCOALink request, send a POST request to any of the four endpoints below with an `address_line1` field equal to `NCOA`:\n- `POST /v1/addresses`\n- `POST /v1/checks`\n- `POST /v1/letters`\n- `POST /v1/postcards`\n- `POST /v1/self_mailers`\n\nA static address will always be returned, as documented in the `ncoa_us_test` example under [Response samples](#operation/address_create) within the \"Create an Address\"\nsection in Addresses (along with the corresponding request under \"Request samples\").\n
back to top
\n", @@ -10577,7 +10637,7 @@ "event": [] }, { - "id": "5f9959e0-ada5-418f-84bc-ee52b444bf2f", + "id": "2f04a47d-bc40-4def-bcf4-e9a768a7872f", "name": "Postcards", "description": { "content": "The postcards endpoint allows you to easily print and mail postcards. The API provides endpoints for creating postcards,\nretrieving individual postcards, canceling postcards, and retrieving a list of postcards.\n
back to top
\n", @@ -10585,7 +10645,7 @@ }, "item": [ { - "id": "4e6415d5-eb32-4ebd-a6e3-28b6f36fbc5b", + "id": "afb258cf-88d3-475b-9fb8-960c574cc8d3", "name": "Retrieve", "request": { "name": "Retrieve", @@ -10623,7 +10683,7 @@ }, "response": [ { - "id": "a9808454-33ee-4121-a3ea-05d60a93feb8", + "id": "6435f3c2-fa87-4c6c-b5c5-2cbc37baa5c9", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -10671,7 +10731,7 @@ "_postman_previewlanguage": "json" }, { - "id": "22bdc1fb-0b4a-4fa0-8da4-0ffa55e25960", + "id": "ba0cc9fa-acb6-44f6-aaee-b3f2d328ef79", "name": "Error", "originalRequest": { "url": { @@ -10722,7 +10782,7 @@ "event": [] }, { - "id": "32dbf16e-4ca4-4127-8ac5-db5c22df7a3e", + "id": "8c8ca35b-82d5-4030-9e43-67f0cc15a474", "name": "Cancel", "request": { "name": "Cancel", @@ -10760,7 +10820,7 @@ }, "response": [ { - "id": "16645065-66bb-4496-a689-51a7e85620e3", + "id": "99d2bbc6-9fb3-4c91-a362-30687250b8a4", "name": "Deleted", "originalRequest": { "url": { @@ -10808,7 +10868,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fadb080d-847d-4af4-8423-8a355f4a97c8", + "id": "2c469759-116b-46c5-820c-b59e6c930797", "name": "Error", "originalRequest": { "url": { @@ -10859,7 +10919,7 @@ "event": [] }, { - "id": "34d64d82-2d40-4f78-98d1-f15b8636889d", + "id": "c35b0b46-684f-4753-8de8-031b354d1674", "name": "List", "request": { "name": "List", @@ -10907,7 +10967,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -10973,7 +11051,7 @@ }, "response": [ { - "id": "04a4f5de-07de-402d-b2f7-e18186cb8cdf", + "id": "6aa26e3b-b5dd-445a-980c-46c79fecb353", "name": "A dictionary with a data property that contains an array of up to `limit` postcards. Each entry in the array is a separate postcard. The previous and next page of postcards can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more postcards are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -11005,15 +11083,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -11077,7 +11151,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5c19d852-5833-4b0e-b86c-6ee14ad5275d", + "id": "d25b99cd-2dbe-4d4e-8933-0d92cba34684", "name": "Error", "originalRequest": { "url": { @@ -11109,15 +11183,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -11184,7 +11254,7 @@ "event": [] }, { - "id": "fc4436aa-fc85-41ce-a873-89c19b9a40e0", + "id": "5b2b9546-880f-4395-984f-50a41bd91c7f", "name": "Create", "request": { "name": "Create", @@ -11350,7 +11420,7 @@ }, "response": [ { - "id": "b6f961bb-437e-4c4b-98a7-2b1afedcea7a", + "id": "0a9514ce-e00b-4a90-8acc-0ebf625d2ddf", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -11612,7 +11682,7 @@ "_postman_previewlanguage": "json" }, { - "id": "25a354e1-f5ac-4b3a-baf2-9323b74a6b10", + "id": "72f9df60-9c80-4fe6-b08a-30bf60692bb3", "name": "Error", "originalRequest": { "url": { @@ -11865,7 +11935,7 @@ "event": [] }, { - "id": "7e1a5de3-c68c-493a-af43-953f4895de57", + "id": "ce0dd096-41e7-4be5-a445-791b63ddc133", "name": "QR Codes", "description": { "content": "\nLob QR codes allow you to generate a QR code that is unique to each mailpiece, thereby allowing each and every customers to receive a personalized link. See the Create endpoint for Letters, Postcards or Self Mailers to learn how to embed a QR code into your mail piece.\n\nWebhooks can be used to integrate Lob QR code scans into your omni channel marketing strategy. See the Webhooks section of our documentation to learn how to enable the `letter.viewed`, `postcard.viewed` and `self_mailer.viewed` event notifications for your mail pieces.\n\nFurthermore, our QR code Analytics endpoint can be used to track the impact and engagement rate of your mail sends. Lob can tell you exactly which recipients opened your mailpiece. Our Analytics endpoint allows you to see exactly which recipient scanned a mailpiece, when they scanned it, and more!\n\n
back to top
\n", @@ -11873,7 +11943,7 @@ }, "item": [ { - "id": "fd0bf7a6-e7fd-413a-9490-05cc7de817a1", + "id": "baa3b8ce-37f2-4069-b1cf-19dbf936935c", "name": "List", "request": { "name": "List", @@ -11915,7 +11985,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -11939,7 +12027,7 @@ }, "response": [ { - "id": "3f887ba9-0ad2-4798-936c-acb48179dd62", + "id": "c050d1f0-54fd-4182-a4e3-0a165146872c", "name": "Returns a list of QR Codes and their analytics.", "originalRequest": { "url": { @@ -11967,15 +12055,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -12017,7 +12101,7 @@ "event": [] }, { - "id": "282b5027-685e-47aa-9473-68070a0a75c9", + "id": "4459ee88-bb53-4692-85d9-eb985d55889f", "name": "Rate Limiting", "description": { "content": "To prevent misuse, we enforce a rate limit on an API Key and endpoint basis, similar to the way many other APIs enforce rate limits. By default, all accounts and their corresponding Test and Live API Keys have a rate limit of 150 requests per 5 seconds per endpoint. The `POST /v1/us_verifications` and `POST /v1/us_autocompletions` endpoints have a limit of 300 requests per 5 seconds for all accounts.\n\nWhen your application exceeds the rate limit for a given API endpoint, the Lob API will return an HTTP 429 \"Too Many Requests\" response code instead of the variety of codes you would find across the other API endpoints.\n\n**HTTP Headers**\n\nHTTP headers are returned on each request to a rate limited endpoint. Ensure that you inspect these headers during your requests as they provide relevant data on how many more requests your application is allowed to make for the endpoint you just utilized.\n\nWhile the headers are documented here in titlecase, HTTP headers are case insensitive and certain libraries may transform them to lowercase. Please inspect your headers carefully to see how they will be represented in your chosen development scenario.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
X-Rate-Limit-Limit:the rate limit ceiling for a given request
X-Rate-Limit-Remaining:the number of requests remaining in this window
X-Rate-Limit-Reset:the time at which the rate limit window resets (in UTC epoch seconds)\n
\n\n### Example HTTP Headers\n\n```bash\n X-Rate-Limit-Limit:150\n X-Rate-Limit-Remaining:100\n X-Rate-Limit-Reset:1528749846\n```\n\n### Example Response\n\nIf you hit the rate limit on a given endpoint, this is the body of the HTTP 429 message that you will see:\n\n```javascript\n {\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"code\": \"rate_limit_exceeded\",\n \"status_code\": 429\n }\n }\n```
back to top
", @@ -12027,7 +12111,7 @@ "event": [] }, { - "id": "dacea72a-e5ba-434e-810a-9e75d1328139", + "id": "723a50e6-a87a-4941-87de-a2c1a5013126", "name": "Requests and Responses", "description": { "content": "## Asset URLs\n\nAll asset URLs returned by the Lob API (postcards, letters, thumbnails,\netc) are signed links served over HTTPS. All links returned will expire in\n30 days to prevent mis-sharing. Each time a GET request is initiated, a\nnew signed URL will be generated.\n
\n
back to top
\n\n## Query Parameters\n\nQuery parameters which consist of lists of strings require that all elements of\nthe list be double-quoted, as per query filter standards.\n
\n
back to top
\n\n## Idempotent Requests\n\nLob supports idempotency for safely retrying `POST` requests to create\npostcards, self mailers, letters, and checks without accidentally creating\nduplicates.\n\nFor example, if a request to create a check fails due to a network error,\nyou can safely retry the same request with the same idempotency key and\nguarantee that only one check will ultimately be created and sent. When a\nrequest is sent with an idempotency key for an already created resource,\nthe response object for the existing resource will be returned.\n\nTo perform an idempotent `POST` request to one of the mailpiece product\nendpoints, provide an additional `Idempotency-Key` header or an `idempotency_key`\nquery parameter to the request. If multiple idempotency keys are provided,\nthe request will fail. How you create unique keys is up to you, but we\nsuggest using random values, such as V4 UUIDs. Idempotency keys are intended\nto prevent issues over a short periods of time, therefore keys expire after\n24 hours. Keys are unique by mode (Test vs. Live) as well as by resource\n(postcard vs. letter, etc.).\n\nBy default, all `GET` and `DELETE` requests are idempotent by nature, so\nthey do not require an additional idempotency key.\n\nFor more help integrating idempotency keys, refer to our\nimplementation guide.\n\n**Headers**\n\n \n \n \n \n \n \n
Idempotency-Key:\n optional\n

\n \n A string of no longer than 256 characters\n that uniquely identifies this resource.\n \n

\n
\n\n**Query Parameters**\n\n \n \n \n \n \n \n
idempotency-key:\n optional\n

\n \n A string of no longer than 256 characters\n that uniquely identifies this resource.\n \n

\n
\n\n### Example Request\n\n```bash\n curl https://api.lob.com/v1/postcards \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -H \"Idempotency-Key: 026e7634-24d7-486c-a0bb-4a17fd0eebc5\" \\\n -d \"to=adr_bae820679f3f536b\" \\\n -d \"from=adr_210a8d4b0b76d77b\" \\\n --data-urlencode \"front=Front HTML for {{name}}\" \\\n --data-urlencode \"back=Back HTML\" \\\n -d \"merge_variables[name]=Harry\"\n```\n
\n
back to top
\n\n## Metadata\n\nWhen creating any Lob object, you can include a metadata object with up to 20 key-value pairs of\ncustom data. You can use metadata to store information like `metadata[customer_id] = \"987654\"` or\n`metadata[campaign] = \"NEWYORK2015\"`. This is especially useful for filtering and matching to internal\nsystems.\n\nEach metadata key must be less than 40 characters long and values must be less than 500 characters.\nMetadata does not support nested objects.\n\n### Example Create Request with Metadata\n\n```bash\n curl https://api.lob.com/v1/postcards \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -d \"description=Demo Postcard job\" \\\n -d \"metadata[campaign]=NEWYORK2015\" \\\n -d \"to=adr_bae820679f3f536b\" \\\n -d \"from=adr_210a8d4b0b76d77b\" \\\n --data-urlencode \"front=Front HTML for {{name}}\" \\\n --data-urlencode \"back=Back HTML\" \\\n -d \"merge_variables[name]=Harry\"\n```\n\n### Example List Request with Metadata Filter\n\n```bash\n curl -g \"https://api.lob.com/v1/postcards?metadata[campaign]=NEWYORK2015&limit=2\" \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n```\n
\n
back to top
\n\n\n## Request Body\n\nWhen manually sending a POST HTTP request directly to the Lob API, without\nthe use of a library, you may represent the body as either a Form URL\nEncoded request, a JSON document, or a Multipart Form Data request.\n\nHowever, if you're using one of our [SDKs](#tag/SDKs-and-Tools),\nthe generation of the request bodies is done for you automatically and you don't\nneed to worry about the format.\n\nFor fields that are intended to accept only string values, submitting JSON objects in string format (stringified JSON objects) is not supported. \nOur system automatically parses and validates incoming data according to their expected types. \nAs a result, providing a stringified JSON object in a field designated for string input can cause parsing errors or lead to unexpected validation results.\n\n### Form URL Encoded\n\nThis request body encoding is accompanied with the\n`Content-Type: application/x-www-form-urlencoded` header. The content is an\nexample of what the [Verify a US address](index.html#operation/us_verification)\nendpoint accepts. An example of a request body encoded in this format follows.\n\n\n```javascript\n primary_line=210 King Street&city=San Francisco&state=CA&zip_code=94107\n```\n\n### JSON\n\nThis request body encoding is accompanied with the `Content-Type: application/json` header.\nThe content is an example of what the [Verify a US address endpoint](index.html#operation/us_verification)\naccepts. An example of a request body encoded in this format follows.\n\n\n```javascript\n {\n \"primary_line\": \"210 King Street\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94107\"\n }\n```\n\n### Multipart Form Data\n\nThis request body encoding is accompanied with the `Content-Type: multipart/form-data`\nheader. This is the only format that can be used for uploading a file to the API. The\ncontent is an example of what the [Create a check](index.html#operation/check_create)\nendpoint accepts. An example of a request body encoded in this format follows.\n\n\n```javascript\n --------------------------7015ebe79c0a5f8c\n Content-Disposition: form-data; name=\"description\"\n\n Demo Letter\n --------------------------7015ebe79c0a5f8c\n Content-Disposition: form-data; name=\"to\"\n\n adr_bae820679f3f536b\n --------------------------7015ebe79c0a5f8c\n Content-Disposition: form-data; name=\"from\"\n\n adr_210a8d4b0b76d77b\n --------------------------7015ebe79c0a5f8c\n Content-Disposition: form-data; name=\"file\"; filename=\"file.pdf\"\n Content-Type: application/pdf\n\n \n --------------------------7015ebe79c0a5f8c\n Content-Disposition: form-data; name=\"color\"\n\n true\n --------------------------7015ebe79c0a5f8c--\n```\n
back to top
\n", @@ -12037,7 +12121,7 @@ "event": [] }, { - "id": "f98a5c18-6397-4071-9dc3-9b9f67c3506d", + "id": "b670bcf3-677a-468c-b1c3-2bd816449cdc", "name": "Reverse Geocode Lookups", "description": { "content": "Find a list of zip codes associated with a valid US location via latitude and longitude.
back to top
\n", @@ -12045,7 +12129,7 @@ }, "item": [ { - "id": "57efb231-602b-48ad-b25c-7e17dce8f9eb", + "id": "c4626386-8577-4bce-ab0d-bf2ce7bab574", "name": "Reverse Geocode Lookup", "request": { "name": "Reverse Geocode Lookup", @@ -12102,7 +12186,7 @@ }, "response": [ { - "id": "3941db64-42fb-4864-bd28-496c3a341299", + "id": "515b61c6-9cfe-4fec-ae7c-3c83fbbb6168", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -12186,7 +12270,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4d839165-abe0-4793-a4b7-3bf14badba55", + "id": "b09781b2-ef55-4ba0-969c-d8ea9982452e", "name": "Error", "originalRequest": { "url": { @@ -12261,7 +12345,7 @@ "event": [] }, { - "id": "0116bc3d-71de-4e06-8602-4f3a8f2473d8", + "id": "ee0e40cb-88bc-4c2e-9be6-3d617b99b3d6", "name": "SDKs and Tools", "description": { "content": "Please visit our Github for a list of our supported libraries.\n- Typescript\n- PHP\n- Python\n- Java\n- Ruby\n- CSharp\n- Elixir\n- Go\n- Node.js (legacy)\n- Java (legacy)\n- PHP (legacy)\n- Python (Legacy)\n- Ruby (Legacy)\n\n

\n
back to top
\n", @@ -12271,7 +12355,7 @@ "event": [] }, { - "id": "29c1a719-a97c-4c16-b8d9-b0cd8e64ecf9", + "id": "1308dd96-2f71-4f5a-98f1-ac87ee9e255f", "name": "Self Mailers", "description": { "content": "The self mailer endpoint allows you to easily print and mail self mailers. The API provides endpoints\nfor creating self mailers, retrieving individual self mailers, canceling self mailers, and retrieving a list of self mailers.\n
back to top
\n", @@ -12279,7 +12363,7 @@ }, "item": [ { - "id": "8a69f339-2b90-4e85-94fc-2ed61bd6479a", + "id": "879d7536-185a-4677-bc23-2112fec5e6bb", "name": "Retrieve", "request": { "name": "Retrieve", @@ -12317,7 +12401,7 @@ }, "response": [ { - "id": "015aa914-a81c-4f68-88c5-a6fcc258dff4", + "id": "830d28d4-f08b-438b-99fe-09ef505892f8", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -12365,7 +12449,7 @@ "_postman_previewlanguage": "json" }, { - "id": "83bb45fe-1cfe-4789-8a0f-0946fc102c87", + "id": "914b0eda-5dc6-4fe6-9f8c-dcc3852d0a19", "name": "Error", "originalRequest": { "url": { @@ -12416,7 +12500,7 @@ "event": [] }, { - "id": "58417fed-b7e1-4096-8e9b-63cf0273355c", + "id": "cf2ef20c-798c-4f9c-baf0-2a55ba8060c2", "name": "Delete", "request": { "name": "Delete", @@ -12454,7 +12538,7 @@ }, "response": [ { - "id": "a3a39695-a7bb-40ca-9573-be1cad47fda9", + "id": "ab4fd304-3b4b-4b6b-97f5-76bbb4d72435", "name": "Deleted", "originalRequest": { "url": { @@ -12502,7 +12586,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f6af7070-c009-4d1c-a7d0-82e9c2c1f34e", + "id": "6d2af602-24d5-416b-8ad3-9ea782dda95e", "name": "Error", "originalRequest": { "url": { @@ -12553,7 +12637,7 @@ "event": [] }, { - "id": "4dac8ae7-65d3-4639-ae01-3994765fc597", + "id": "97543d3a-b64c-405b-8366-adaf78175358", "name": "List", "request": { "name": "List", @@ -12601,7 +12685,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -12667,7 +12769,7 @@ }, "response": [ { - "id": "dc6da665-efc3-41ed-8020-4357c210c3ba", + "id": "7839dea5-e8be-4c45-b758-a98dafe04fb2", "name": "A dictionary with a data property that contains an array of up to `limit` self_mailers. Each entry in the array is a separate self_mailer. The previous and next page of self_mailers can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more self_mailers are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -12699,15 +12801,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -12771,7 +12869,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4a96c402-729e-488c-b65e-4b43212de0fc", + "id": "e5252692-f764-4e2e-8919-3b5ba7ed8bd7", "name": "Error", "originalRequest": { "url": { @@ -12803,15 +12901,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -12878,7 +12972,7 @@ "event": [] }, { - "id": "05f5a64d-0f08-463f-80ea-acb4f2b48e61", + "id": "8d9ad342-911b-48cc-8922-1e17b5a3cb70", "name": "Create", "request": { "name": "Create", @@ -13044,7 +13138,7 @@ }, "response": [ { - "id": "ad9fe100-485a-4bc3-9b1c-67213d57be86", + "id": "06aa64e9-cc06-4710-bd71-4a850614104b", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -13206,7 +13300,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1f0ce8da-294a-4e2d-9035-36a947e1f1ab", + "id": "1fc39d4a-ffc1-4d02-8c2f-aadfc7f82bd8", "name": "Error", "originalRequest": { "url": { @@ -13359,7 +13453,7 @@ "event": [] }, { - "id": "a6c0c154-2d96-4733-888e-ff49b6f4db71", + "id": "99788de2-e6b6-47f9-8679-3c6cc72b2c43", "name": "Template Design", "description": { "content": "## HTML Templates\nYou can save commonly used HTML as templates within Lob to more easily manage them. You can reference\nyour saved templates in postcard, letter, and check requests instead of having to pass a long HTML\nstring on each request. Additionally, you can make changes to your HTML templates and update them\nindependently, without having to touch your API integration. Templates can be created, edited,\nand viewed on your Dashboard. To use a template in a postcard,\nletter, or check, see the documentation for each endpoint below. For help using templates, check out our\nHTML Templates Guide or get started with a\npre-designed template from our gallery. In Live mode, you can only have\nas many templates as allotted in your current\nPrint & Mail Edition. There is no limit in Test mode.\n\nIf you'd like to interact with templates programmatically, check out our Beta Program for API access\nto the [HTML Templates Endpoints](#tag/Templates).\n\n### Example Create Request using HTML Templates\n```bash\n curl https://api.lob.com/v1/postcards \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -d \"description=Demo Postcard job\" \\\n -d \"to=adr_78c304d54912c502\" \\\n -d \"from=adr_61a0865c8c573139\" \\\n -d \"front=tmpl_b846a20859ae11a\" \\\n -d \"back=tmpl_01b0d396a10c268\" \\\n -d \"merge_variables[name]=Harry\"\n```\n
\n
back to top
\n\n## HTML Examples\nUse a pre-designed template from our gallery or follow these\nbasic guidelines as starting points for creating custom Postcards,\nSelf Mailers, Letters, and Checks.\n\nPlease follow the standards used in these templates, such as:\n- For any linked assets, you must use a performant file hosting provider with no rate limits such as Amazon\nS3.\n- Use inline styles or an internal stylesheet, do not link to external stylesheets.\n- Link to images that are 300DPI and sized at the final desired size on the physical mailing. For example,\nfor a photo that is desired to be 1in x 1in on the final postcard, the image asset should be sized at 1in\nx 1in at 300DPI (which equates to 300px by 300px).\n- The sum of all linked assets should not exceed 5MB in file size.\n- Use `-webkit` prefixes for CSS properties when recommended here.\n\nBecause different browsers have varying user-agent styles, the HTML you see in your browser will not\nalways look identical to what is produced through the API. It is **strongly** recommended that you test all\nHTML requests by reviewing the final PDF files in your Test Environment, as these are the files that will be\nprinted.\n
\n
back to top
\n\n## Image Prepping\nCurrently we support the following file types for all endpoints:\n- PDF\n- PNG\n- JPEG\n\n**Templates**\n\nYou can find pre-made templates that already adhere to all of these guidelines here:\n- [Postcards](#tag/Postcards)\n- [Letters](#tag/Letters)\n- [Checks](#tag/Checks)\n- [Self Mailers](#tag/Self-Mailers)\n\n**Prepping All Images**\n\nThe following guidelines apply to image types:\n- Images should be 300 dpi or higher - PNG/JPEG files with less than 300 dpi will be rejected.\n- Your artwork should include a 1/8\" border around the final trim size. This means your final file size will be a total of 0.25\" larger than your expected printed piece (ie, a 4\"x6\" postcard should be submitted as 4.25\"x6.25\"). There is no need to include crop marks in your submitted content.\n- Include a safe zone – make sure no critical elements are within 1/8\" from the edge of the final size.\n- Do not include any additional postage marks or indicia.\n- File sizes should be no larger than 5MB.\n\n**Prepping PDFs**\n\nTo ensure that you are producing PDF's correctly please follow the guidelines [outlined in our help center here](https://help.lob.com/print-and-mail/designing-mail-creatives/creative-formatting/pdf-preflight-checklist#requirements-for-static-pdfs)\n\n**Prepping PNGs/JPEGs**\n\nTo ensure that you are producing PNG's/JPEG's correctly please follow the guidelines below:\n\n- Minimum 300 dpi. The dpi is calculated as (width of image in pixels) / (width of product in inches) and (length of image in pixels) / (length of product in inches). For Example: 1275px x 1875px image used to create a 4.25\" x 6.25\" postcard has a dpi of 300.\n- Submitted images must have the same length to width ratio as the chosen product. Images will not be cropped or stretched by the API.\n
\n
back to top
\n\n## Standard PDF Fonts\nIdeally, all fonts in provided PDFs should be embedded. Embedding a font in a PDF ensures that the final\nprinted product will look as it was designed. Fonts can vary greatly in size and shape, even within the\nsame family. If the exact font that was used to design the artwork is not used to print, the look and\nplacement of the text is not guaranteed to be the same.\n\nIn general, requests that provide PDFs with un-embedded fonts will be rejected. We make an exception for\n\"standard fonts\", a set of fonts that we have identified as being common. PDFs that contain un-embedded\nfonts that are found in the list, and match the accepted font type\nwill be accepted. Otherwise, the request will be rejected.\n\nFont embedding is an essential part of standard PDF workflows. Fonts should be embedded automatically by\nPDF editing software that are compliant with PDF standards.\n\nPlease note, only standard base14 fonts can be Type 1.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
FONT NAMETYPES
ArialTrueType, CID TrueType
Arial,BoldTrueType, CID TrueType
Arial,BoldItalicTrueType, CID TrueType
Arial,ItalicTrueType, CID TrueType
ArialMTTrueType, CID TrueType
Arial-BoldMTTrueType
Arial-BoldItalicMTTrueType
Arial-ItalicMTTrueType
ArialNarrowTrueType
ArialNarrow-BoldTrueType
CalibriTrueType
Calibri-BoldTrueType
Calibri-ItalicTrueType
CourierType 1
Courier-ObliqueType 1
Courier-BoldType 1
Courier-BoldObliqueType 1
CourierNewPSMTTrueType
CourierNewPS-ItalicMTTrueType
CourierNewPS-BoldMTTrueType
HelveticaType 1
Helvetica-BoldType 1
Helvetica-BoldObliqueType 1
Helvetica-ObliqueType 1
LucidaConsoleTrueType
MsSansSerifTrueType
MsSansSerif,BoldTrueType
SymbolType 1, TrueType
TahomaTrueType
Tahoma-BoldTrueType
Times-BoldType 1
Times-BoldItalicType 1
Times-ItalicType 1
Times-RomanType 1
TimesNewRomanPS-BoldItalicMTTrueType
TimesNewRomanPS-BoldMTTrueType
TimesNewRomanPS-ItalicMTTrueType
TimesNewRomanPSMTTrueType, CID TrueType
TimesNewRomanPSMT,BoldTrueType
VerdanaTrueType
Verdana-BoldTrueType
Verdana,ItalicTrueType
ZapfDingbatsType 1
\n
back to top
\n", @@ -13369,7 +13463,7 @@ "event": [] }, { - "id": "6fb01b8c-3377-4d51-a271-c4434d5e19a5", + "id": "797ae4a5-54e6-413b-9f1c-93b8a62c9d29", "name": "Template Versions", "description": { "content": "These API endpoints allow you to create, retrieve, update and delete versions of reusable HTML templates for use with the Print & Mail API.\n
back to top
\n", @@ -13377,7 +13471,7 @@ }, "item": [ { - "id": "769fbda5-25cc-48da-b1e4-ca844969a61b", + "id": "a3111cac-83ca-41c2-a5de-bd13e91eafd9", "name": "Retrieve", "request": { "name": "Retrieve", @@ -13424,7 +13518,7 @@ }, "response": [ { - "id": "d91b9343-973a-4eb4-a8e8-462a7d070878", + "id": "f4133454-3293-47d8-aa79-0a9f2d3d4fc3", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -13481,7 +13575,7 @@ "_postman_previewlanguage": "json" }, { - "id": "34ad3f5b-a30f-4abd-9bf5-08b83b8f3e99", + "id": "f4ffbd89-c2a2-4062-a8e7-dcd7ddfb9ea8", "name": "Error", "originalRequest": { "url": { @@ -13541,7 +13635,7 @@ "event": [] }, { - "id": "df6172e4-5854-4299-8065-e2c530ca5830", + "id": "47c30c4a-1f29-4940-8be9-fd1f0fc73b52", "name": "Update", "request": { "name": "Update", @@ -13617,7 +13711,7 @@ }, "response": [ { - "id": "85cecf01-bc2e-4326-b610-8d5342dc5a3b", + "id": "0acd1ffb-da89-498f-a0b7-6a7cd2bfb250", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -13701,7 +13795,7 @@ "_postman_previewlanguage": "json" }, { - "id": "233f9fde-ced1-465a-88de-ebd94b8981b7", + "id": "300da865-c9d7-4a59-a501-757b371e95f1", "name": "Error", "originalRequest": { "url": { @@ -13773,7 +13867,7 @@ } }, { - "id": "e5eaa129-4ec5-4883-ac0d-ca5b27e19a35", + "id": "7d70b68a-3d1c-49d1-bdb7-07a49378294d", "name": "Delete", "request": { "name": "Delete", @@ -13820,7 +13914,7 @@ }, "response": [ { - "id": "3216dd3a-d0d5-4cc9-87b0-c1172c0b3949", + "id": "8e98d69d-b3cd-40d4-93d7-919daf54c8ba", "name": "Deleted", "originalRequest": { "url": { @@ -13877,7 +13971,7 @@ "_postman_previewlanguage": "json" }, { - "id": "10fe434a-ddd4-44b0-b0f0-b30269ef7217", + "id": "7061c4fc-5ed1-46c2-a293-f085c05d1c98", "name": "Error", "originalRequest": { "url": { @@ -13937,7 +14031,7 @@ "event": [] }, { - "id": "34b4eba2-ff40-45b1-ac99-0da3f188e2b9", + "id": "558de1da-89f9-4700-9b66-df56ae25ae8c", "name": "List", "request": { "name": "List", @@ -13987,7 +14081,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." } @@ -14013,7 +14125,7 @@ }, "response": [ { - "id": "d5545031-0a66-4671-8453-95c05e1f3f03", + "id": "7e2bf32d-d1c0-45c8-be08-8410bba2b12a", "name": "A dictionary with a data property that contains an array of up to `limit` template versions. Each entry in the array is a separate template version object. The previous and next page of template versions can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more template versions are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -14047,15 +14159,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -14095,7 +14203,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6f3411b9-daad-48ee-b900-562b52a87d3f", + "id": "f6dbf85e-e1bd-448d-82f7-7d20bd00a00b", "name": "Error", "originalRequest": { "url": { @@ -14129,15 +14237,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -14180,7 +14284,7 @@ "event": [] }, { - "id": "675d418e-4d44-4b4a-a06f-c2d43b7dc27c", + "id": "1c2320a6-0cbc-4781-9563-48ccb890b302", "name": "Create", "request": { "name": "Create", @@ -14254,7 +14358,7 @@ }, "response": [ { - "id": "86627094-7dec-4793-a6a2-36cfdb0ee88d", + "id": "a11dbf7e-3dfb-4b0a-b282-bad3f6ffeb7e", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -14339,7 +14443,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c8262898-6e99-4e8a-858e-64848a6890c5", + "id": "e7e53160-c014-4a4a-8d87-d84f854fd98f", "name": "Error", "originalRequest": { "url": { @@ -14415,7 +14519,7 @@ "event": [] }, { - "id": "97ace651-410d-4e90-837a-6c3761f629db", + "id": "5d7c77ef-aa17-4204-9b24-3a5ba785884c", "name": "Templates", "description": { "content": "These API endpoints allow you to create, retrieve, update and delete reusable HTML templates for use with the Print & Mail API.\n
back to top
\n", @@ -14423,7 +14527,7 @@ }, "item": [ { - "id": "105995e6-24fe-4592-aba9-37751b9a394f", + "id": "e3a1f971-25d9-407f-8ad6-e34a69a89c25", "name": "Retrieve", "request": { "name": "Retrieve", @@ -14461,7 +14565,7 @@ }, "response": [ { - "id": "9f7b4763-514f-4c26-becb-30e34e0e6c7e", + "id": "44108020-e73d-4c4a-a5b5-45c253ed6e05", "name": "Returns a template object", "originalRequest": { "url": { @@ -14509,7 +14613,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ae32d2ec-15ce-4e3d-87c7-39206c0ecab4", + "id": "d3bed51b-a75e-41a1-a767-2e3bb90c55a1", "name": "Error", "originalRequest": { "url": { @@ -14560,7 +14664,7 @@ "event": [] }, { - "id": "6ce350a1-71cf-4df2-bfd9-2ff00107b528", + "id": "d5e1750b-8764-4111-8a6b-38c0783241ae", "name": "Update", "request": { "name": "Update", @@ -14617,7 +14721,7 @@ }, "response": [ { - "id": "2896404b-1829-4a70-85b8-42e5d702293d", + "id": "d8a96494-022f-4458-9fa4-c96c6e722d6a", "name": "Returns the updated template object", "originalRequest": { "url": { @@ -14697,7 +14801,7 @@ "_postman_previewlanguage": "json" }, { - "id": "53a5c6e1-b536-4b4e-a011-08eb3e8efc30", + "id": "9a602bfb-a98d-40d1-a5c5-4cfbf32c54e0", "name": "Error", "originalRequest": { "url": { @@ -14765,7 +14869,7 @@ } }, { - "id": "e713d90a-0add-4743-9538-9c845d58f4dc", + "id": "98d32d23-4cde-46e4-8d64-7c4ac5743089", "name": "Delete", "request": { "name": "Delete", @@ -14803,7 +14907,7 @@ }, "response": [ { - "id": "33772779-bb8f-409e-b4e4-92a8f9c23bff", + "id": "b8df3932-9c14-406a-8958-0e7ae95beace", "name": "Deleted", "originalRequest": { "url": { @@ -14851,7 +14955,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dfa7d84e-4caa-4dd2-ad28-133e39f35305", + "id": "251cab95-0b22-4383-8e4d-6e9493a741fc", "name": "Error", "originalRequest": { "url": { @@ -14902,7 +15006,7 @@ "event": [] }, { - "id": "df20baf8-ec71-49ba-b72b-3ce7681c3838", + "id": "2eb2ed17-8475-4102-b776-85eebfe94e5a", "name": "List", "request": { "name": "List", @@ -14950,7 +15054,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." } @@ -14968,7 +15090,7 @@ }, "response": [ { - "id": "89f51fc9-9029-4fa6-88fd-403bb712dcf0", + "id": "4b872ea4-77cb-4167-820c-6414f08ea27f", "name": "A dictionary with a data property that contains an array of up to `limit` templates. Each entry in the array is a separate template. The previous and next page of templates can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more templates are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -15000,15 +15122,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -15040,7 +15158,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c6866cc1-37cd-4425-86ba-d8e96d555436", + "id": "4998e6aa-a45a-418d-b458-8c4b2e4c3d0e", "name": "Error", "originalRequest": { "url": { @@ -15072,15 +15190,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" } ], @@ -15115,7 +15229,7 @@ "event": [] }, { - "id": "cb594214-fd40-42ed-bf1f-ca15776329bc", + "id": "1483e881-938d-4b9e-b143-ae174b339363", "name": "Create", "request": { "name": "Create", @@ -15162,7 +15276,7 @@ { "disabled": false, "key": "metadata", - "value": ",0ML{| Ng4T66Y2.}b%x}(&f[#aT,671qJDw&yv.6ZI`lk % sN<_QgoWo:{&kDN(xv{Na^[{la8STJDGIne!o{q] $`AnU9*0xT7!![K8=Tdj|i,al9(/iH8j'iG-{dSvwLE=Bh%_{J/[8nvk|i[JzG#bg`)[9aL6.~6 5vEqGT.!g1/b*5z_RfGC*5rs/UVjpQJ_T,us)J&]8A#m'5)]K-m3Xykv)KtX*d{Q^)yDn']:fFlTuy{HjQDvYqzYWA^F;>QHV!6H>Wj.lPOZAv0u#X'i40v&4FiDNI,fh`3x7-ahOeBc~>ln'&N$5J{X{e P8klL=5(mHgA4=aVnNOTZb::V*&,Fqiqdmy#mZ*hS;o,pJq8uQb_zRFwE%dqT@0yR$j)rP[#%iFAz&mIs ,%Vt)7CGNj3QPiV$Q A>Tvu1YjRJt:L4zW9bMo>5J" }, { "disabled": false, @@ -15184,7 +15298,7 @@ }, "response": [ { - "id": "c90914b8-3a98-4316-ba88-d2f0c09b42ee", + "id": "ad5b8a97-3d70-40c9-81b1-33d1b9a8808b", "name": "Returns a template object", "originalRequest": { "url": { @@ -15269,7 +15383,7 @@ "_postman_previewlanguage": "json" }, { - "id": "881fcbe6-1e70-4fc7-b033-51d715f1c04f", + "id": "599a49cd-5177-44a8-9089-933b5de2acab", "name": "Error", "originalRequest": { "url": { @@ -15345,7 +15459,7 @@ "event": [] }, { - "id": "408e8cb3-b456-47d7-9c57-c9b7a5d0f061", + "id": "204a8a4f-5c95-4825-9628-2b46a9677738", "name": "Test and Live Environments", "description": { "content": "To make the API as explorable as possible, accounts have test and live\nenvironment API keys. You're not charged any fees in the test environment,\nso we encourage you to use it to try out services, perform quality\nassurance, and run automated testing. Objects―addresses, letters, checks,\netc―in one environment cannot be manipulated by objects in the other.\n\nIn general, a payment method (either credit card or ACH account) must be\nadded to your account to make live API requests. However, a payment method\nis not required for the first 300 live requests per month to the\n`/v1/us_verifications` endpoint. After the first 300 requests, you will\nbegin receiving errors with status code `403`.\n\nRequests made in the test environment always validate request arguments,\nsimulate live environment behavior, and enforce rate limits. _They never\nprint, mail nor, for verification services, verify addresses._ The US &\nInternational verification services trigger behavior with specific\nargument values, and, if you plan on using those, we recommend reading\n[US Verification Test Environment](#tag/US-Verifications-Test-Environment)\nand [Intl Verification Test Environment](#tag/Intl-Verifications-Test-Environment).\n\nTo switch between environments, use the appropriate key for that\nenvironment when performing a request. You can find each environment's API\nkey in your dashboard under Settings; test API keys are always prefixed\nwith `test_` and production API keys with `live_`.\n
back to top
\n", @@ -15355,7 +15469,7 @@ "event": [] }, { - "id": "db0958ff-a595-4052-969e-d06b7017010d", + "id": "6dbaf6ba-4996-4eb9-9e31-7e8af840b277", "name": "Tracking Events", "description": { "content": "As mailpieces travel through the mail stream, USPS scans their unique barcodes, and Lob processes these mail scans to generate tracking events.\n\n

Certified Tracking Event Details

\n\nLetters sent with USPS Certified Mail are fully tracked by USPS, and\ntherefore their [tracking events](#operation/tracking_event) have an\nadditional `details` object with more detailed information about the\ntracking event. The following table shows the potential values for\nthe fields in the `details` object mapped to the tracking event `name`.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NAMEEVENTDESCRIPTIONACTION REQUIRED
Mailedpackage_acceptedPackage has been accepted into the carrier network for delivery.false
In Transitpackage_arrivedPackage has arrived at an intermediate location in the carrier network.false
In Transitpackage_departedPackage has departed from an intermediate location in the carrier network.false
In Transitpackage_processingPackage is processing at an intermediate location in the carrier network.false
In Transitpackage_processedPackage has been processed at an intermediate location.false
In Local Areapackage_in_local_areaPackage is at a location near the end destination.false
Processed For Deliverydelivery_scheduledPackage is scheduled for delivery.false
Processed For Deliveryout_for_deliveryPackage is out for delivery.false
Pickup Availablepickup_availablePackage is available for pickup at carrier location.true
DelivereddeliveredPackage has been delivered.false
Re-Routedpackage_forwardedPackage has been forwarded.false
Returned to Senderreturned_to_senderPackage is to be returned to sender.false
Issueaddress_issueAddress information is incorrect. Contact carrier to ensure delivery.true
Issuecontact_carrierContact the carrier for more information.true
IssuedelayedDelivery of package is delayed.false
Issuedelivery_attemptedDelivery of package has been attempted. Contact carrier to ensure delivery.true
Issuedelivery_rescheduledDelivery of package has been rescheduled.false
Issuelocation_inaccessibleDelivery location inaccessible to carrier. Contact carrier to ensure delivery.true
Issuenotice_leftCarrier left notice during attempted delivery. Follow carrier instructions on notice.true
Issuepackage_damagedPackage has been damaged. Contact carrier for more details.true
Issuepackage_disposedPackage has been disposed.false
Issuepackage_heldPackage held at carrier location. Contact carrier for more details.true
Issuepackage_lostPackage has been lost. Contact carrier for more details.true
Issuepackage_unclaimedPackage is unclaimed.true
Issuepackage_undeliverablePackage is not able to be delivered.true
Issuereschedule_deliveryContact carrier to reschedule delivery.true
IssueotherUnrecognized carrier status.false
\n
back to top
\n", @@ -15365,7 +15479,7 @@ "event": [] }, { - "id": "964cbc38-e3fb-4cb5-bdcb-504fe24d0e18", + "id": "0599ff06-70ea-464f-a47e-c08bb5d68a0e", "name": "Uploads", "description": { "content": "The uploads endpoint allows you to upload audience files that are then associated with a given campaign.\nAt this time, only CSV files are allowed. The API provides endpoints for creating uploads, uploading audience files,\nand marking uploaded files as ready for processing. The API also provides endpoints for downloading files that\ndescribe the results, both successful and not, of the processing.\n", @@ -15373,7 +15487,7 @@ }, "item": [ { - "id": "3d5310ca-f887-4882-9284-efaf0703bff2", + "id": "5322eb63-7e1e-4989-81ca-522788939348", "name": "List", "request": { "name": "List", @@ -15409,7 +15523,7 @@ }, "response": [ { - "id": "cf4b87ce-8980-4a61-a3aa-2533e9c1f5ab", + "id": "c7d132da-774e-45b1-92af-e46b42693360", "name": "An array of matching uploads. Each entry in the array is a separate upload.", "originalRequest": { "url": { @@ -15456,7 +15570,7 @@ "event": [] }, { - "id": "73abef27-6d56-44e6-a890-5df38ccc25f7", + "id": "0a4f5327-d25b-4216-8ba7-e96dac78eed7", "name": "Create", "request": { "name": "Create", @@ -15498,7 +15612,7 @@ }, "response": [ { - "id": "2e66ae98-1143-4da1-998e-44290a4f020b", + "id": "209abb7b-010e-4122-9018-3d99316b8a07", "name": "Upload created successfully", "originalRequest": { "url": { @@ -15545,7 +15659,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f9aaa796-e42e-4e6b-80b8-392693c05e97", + "id": "0cc8bef8-7daa-49ce-94b8-cc936d705cf9", "name": "Validation Error", "originalRequest": { "url": { @@ -15587,7 +15701,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"ut officia incididunt sit\",\n \"labore aliquip\"\n ],\n \"msg\": \"dolore consequat\",\n \"type\": \"et in aute enim\"\n },\n {\n \"loc\": [\n \"Ut velit\",\n \"Duis dolor\"\n ],\n \"msg\": \"laborum deserunt commodo eu\",\n \"type\": \"laborum labore sunt\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"id\",\n \"minim sint sed\"\n ],\n \"msg\": \"veniam nisi dolor occaecat consectetur\",\n \"type\": \"in ut cillum\"\n },\n {\n \"loc\": [\n \"Ut ex anim sunt exercitation\",\n \"Ut officia anim\"\n ],\n \"msg\": \"dolore Duis dolore culpa\",\n \"type\": \"enim Duis pariatur min\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -15598,7 +15712,7 @@ } }, { - "id": "01d3144b-3087-42c7-b885-f62924e916c7", + "id": "83369b28-5101-4d84-9a06-345ac15705c1", "name": "Retrieve", "request": { "name": "Retrieve", @@ -15636,7 +15750,7 @@ }, "response": [ { - "id": "6f98ccb5-fc49-4f92-8e05-72ee18c4e0d3", + "id": "869a8c15-2f5a-4ee4-afc7-8de3eb2c3ed0", "name": "Returns an upload object", "originalRequest": { "url": { @@ -15684,7 +15798,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8bf57ef8-8f81-4943-bfe2-ce88c03e5938", + "id": "9b113dd0-88fe-4fec-83c1-b9adc82df864", "name": "Not Found Error", "originalRequest": { "url": { @@ -15732,7 +15846,7 @@ "_postman_previewlanguage": "json" }, { - "id": "58b7e56c-3b91-4296-9781-4e763c46d26c", + "id": "2b953394-d689-4b1a-9422-44f47d1a99ae", "name": "Validation Error", "originalRequest": { "url": { @@ -15775,7 +15889,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Ut tempor pariatur\",\n \"ut commodo irure veniam\"\n ],\n \"msg\": \"aliqua veniam elit\",\n \"type\": \"quis a\"\n },\n {\n \"loc\": [\n \"amet Duis proident\",\n \"in quis labori\"\n ],\n \"msg\": \"Ut ullamco dolor velit\",\n \"type\": \"do eu qu\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"officia exercitation\",\n \"aliqua aute mollit exercitation\"\n ],\n \"msg\": \"m\",\n \"type\": \"ut aliqua dolore incididunt\"\n },\n {\n \"loc\": [\n \"quis eiusmod consequat dolore\",\n \"est magna e\"\n ],\n \"msg\": \"magna cillum consequat\",\n \"type\": \"sit laborum dolore sunt ut\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -15783,7 +15897,7 @@ "event": [] }, { - "id": "a3491760-ee79-4792-a0aa-42381bb06c20", + "id": "fab28a26-0455-4dec-b0c9-25c26d373e17", "name": "Update", "request": { "name": "Update", @@ -15834,7 +15948,7 @@ }, "response": [ { - "id": "290094c8-1af7-4bf0-952a-516ea38f6e0b", + "id": "b58ffba4-db55-43dc-bf24-209dbfe535e8", "name": "Returns an upload object", "originalRequest": { "url": { @@ -15890,7 +16004,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fb4fbabe-6775-4758-9739-be50e56a7969", + "id": "edd8a07d-3587-4f5f-bd3b-a81e0ccc7c27", "name": "Not Found Error", "originalRequest": { "url": { @@ -15946,7 +16060,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e8ee67d0-9c9e-4371-a089-4485953e4802", + "id": "57eeac29-471f-4aa7-9546-2618629a96ef", "name": "Validation Error", "originalRequest": { "url": { @@ -15997,7 +16111,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Ut tempor pariatur\",\n \"ut commodo irure veniam\"\n ],\n \"msg\": \"aliqua veniam elit\",\n \"type\": \"quis a\"\n },\n {\n \"loc\": [\n \"amet Duis proident\",\n \"in quis labori\"\n ],\n \"msg\": \"Ut ullamco dolor velit\",\n \"type\": \"do eu qu\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"officia exercitation\",\n \"aliqua aute mollit exercitation\"\n ],\n \"msg\": \"m\",\n \"type\": \"ut aliqua dolore incididunt\"\n },\n {\n \"loc\": [\n \"quis eiusmod consequat dolore\",\n \"est magna e\"\n ],\n \"msg\": \"magna cillum consequat\",\n \"type\": \"sit laborum dolore sunt ut\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16008,7 +16122,7 @@ } }, { - "id": "2e8a2e37-cfb1-45ff-8055-0c05c6b47b01", + "id": "17598841-f5c3-4f16-a821-34a6d2b0aa5d", "name": "Delete", "request": { "name": "Delete", @@ -16040,7 +16154,7 @@ }, "response": [ { - "id": "9edd66bd-51b1-4aa8-90a0-71371915a515", + "id": "c8aba56c-4230-4c10-927b-b33518c5877c", "name": "Successful Response", "originalRequest": { "url": { @@ -16091,7 +16205,7 @@ "event": [] }, { - "id": "4070f3c0-5261-4704-828c-f17229223764", + "id": "2c1a5ed6-50b3-4372-b82d-9f5d61dd7edd", "name": "Upload file", "request": { "name": "Upload file", @@ -16144,7 +16258,7 @@ }, "response": [ { - "id": "165268b0-1eb5-4b1a-b5fb-5cdc18780d00", + "id": "2d13d303-fe19-4d8b-9053-46a84df4d6d7", "name": "Successful Response", "originalRequest": { "url": { @@ -16201,12 +16315,12 @@ "value": "application/json" } ], - "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"do ut minim\"\n}", + "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"sit aliqua\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "2a789544-da4f-4b61-bc23-2344bd5b1d8b", + "id": "b20e0057-0b83-467d-a09c-2d39a69e3e4c", "name": "Validation Error", "originalRequest": { "url": { @@ -16263,7 +16377,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Ut tempor pariatur\",\n \"ut commodo irure veniam\"\n ],\n \"msg\": \"aliqua veniam elit\",\n \"type\": \"quis a\"\n },\n {\n \"loc\": [\n \"amet Duis proident\",\n \"in quis labori\"\n ],\n \"msg\": \"Ut ullamco dolor velit\",\n \"type\": \"do eu qu\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"officia exercitation\",\n \"aliqua aute mollit exercitation\"\n ],\n \"msg\": \"m\",\n \"type\": \"ut aliqua dolore incididunt\"\n },\n {\n \"loc\": [\n \"quis eiusmod consequat dolore\",\n \"est magna e\"\n ],\n \"msg\": \"magna cillum consequat\",\n \"type\": \"sit laborum dolore sunt ut\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16274,7 +16388,7 @@ } }, { - "id": "3d1a4319-4506-4e11-80bb-60bfc9ca17ae", + "id": "24ed7d26-0c52-44f8-b1f1-bd5dc8a3ce0c", "name": "Create Export", "request": { "name": "Create Export", @@ -16326,7 +16440,7 @@ }, "response": [ { - "id": "36dc8c18-25cc-4762-9103-0fcb2e6c5098", + "id": "560c33ca-12ec-41b7-bc03-49b797abd536", "name": "Successful Response", "originalRequest": { "url": { @@ -16383,7 +16497,7 @@ "_postman_previewlanguage": "json" }, { - "id": "91bae59f-aec9-4666-b14e-3c5a3dd83ac1", + "id": "966158ab-1e3e-4785-b52a-05c8547be24a", "name": "Create Export Error", "originalRequest": { "url": { @@ -16446,7 +16560,7 @@ } }, { - "id": "f986851c-920d-4b21-9f9e-ed99e011448a", + "id": "3a0889ba-282e-41dd-b4fa-96d562583a63", "name": "Retrieve Line Item Report", "request": { "name": "Retrieve Line Item Report", @@ -16504,7 +16618,7 @@ }, "response": [ { - "id": "4142a745-42a9-4cd8-b72b-6e3bf20a30e9", + "id": "bcad433f-d086-4ce5-9269-a4d0125c1821", "name": "Returns an report object", "originalRequest": { "url": { @@ -16566,69 +16680,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d24cb5ee-465d-4aa5-87da-03301d6556e8", - "name": "Forbidden Error", - "originalRequest": { - "url": { - "path": [ - "uploads", - ":upl_id", - "report" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "status", - "value": "" - }, - { - "key": "limit", - "value": "10" - }, - { - "key": "offset", - "value": "0" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "upl_id", - "description": "(Required) ID of the upload" - } - ] - }, - "header": [ - { - "description": { - "content": "Added as a part of security scheme: basic", - "type": "text/plain" - }, - "key": "Authorization", - "value": "Basic " - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"message\": \"This feature is not enabled for this account: access_upload_report\",\n \"code\": 403\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9bd8c095-0b07-4cc1-adb2-36b48509a789", + "id": "61884603-914f-410e-b1ac-e6b0fe5134e4", "name": "Not Found Error", "originalRequest": { "url": { @@ -16693,7 +16745,7 @@ "event": [] }, { - "id": "6884ac7f-106b-4b3d-8bf4-927917cb53f1", + "id": "6565c7fa-2859-4b38-b2a8-e6182ed1cfba", "name": "Retrieve Export", "request": { "name": "Retrieve Export", @@ -16740,7 +16792,7 @@ }, "response": [ { - "id": "02b14085-bab9-482c-8fde-05b5c1bedd14", + "id": "639953c0-5dff-4ebe-a86e-7ac6b7853eb6", "name": "Returns an export object", "originalRequest": { "url": { @@ -16803,7 +16855,7 @@ "event": [] }, { - "id": "6b886631-a908-4377-91d5-7013ccd1729c", + "id": "01801cce-a8c2-4c93-86e0-4e19dbaf2eeb", "name": "URL Shortener", "description": { "content": "Lob's URL shortener allows you to generate unique short links, either with Lob's own domain or your own custom domains. Each custom link enables Lob to track mail individually and provide customers the relevant tracking data in their dashboard.\n\nWebhooks can be used to integrate Lob's URL Shortener scans into your omni channel marketing stratergy. See the Webhooks section of our documentation to learn how to enable the `letter.viewed`, `postcard.viewed` and `self_mailer.viewed` event notifications for your mail pieces.\n\nFurthermore, you can use our Retrieve endpoints to track the impact and engagement rate of links created. \n\n
back to top
\n", @@ -16811,7 +16863,7 @@ }, "item": [ { - "id": "284e8356-98d1-40a0-804f-3a0abc1f5028", + "id": "86a936ae-adaa-47da-9209-a2d835b4bed2", "name": "Retrieve a domain", "request": { "name": "Retrieve a domain", @@ -16849,7 +16901,7 @@ }, "response": [ { - "id": "6f791ff4-40aa-4791-a3db-ece5f52648f1", + "id": "e19bfbb6-32e7-4520-aa89-189c731a768d", "name": "Returns domain related details.", "originalRequest": { "url": { @@ -16892,12 +16944,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"commodo in dolore officia\",\n \"domain\": \"dolore ad\",\n \"error_redirect_link\": \"qui minim in\",\n \"status\": \"not_configured\",\n \"created_at\": \"ipsum eiusmod\",\n \"updated_at\": \"et esse nulla\"\n}", + "body": "{\n \"id\": \"laboris cupidatat nisi commodo\",\n \"domain\": \"quis Lorem ut\",\n \"error_redirect_link\": \"et amet esse quis\",\n \"status\": \"not_configured\",\n \"created_at\": \"sunt do\",\n \"updated_at\": \"velit dolore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1a092caf-6945-45bd-9bba-265116cea338", + "id": "436c578f-a113-4faf-b7fa-0828ab5d89f1", "name": "Error", "originalRequest": { "url": { @@ -16940,7 +16992,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16948,7 +17000,7 @@ "event": [] }, { - "id": "565facfb-4383-495f-a866-a8d1e1d0d95d", + "id": "9a119d87-5584-4f3b-b6dd-f6dddd8850ea", "name": "Delete a Domain", "request": { "name": "Delete a Domain", @@ -16986,7 +17038,7 @@ }, "response": [ { - "id": "5597ba62-702f-4446-8369-b328492c7b02", + "id": "3e331847-dd32-48e6-a248-44973184ad0a", "name": "Returns the deleted link object.", "originalRequest": { "url": { @@ -17029,12 +17081,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"aliquip in\",\n \"deleted\": true\n}", + "body": "{\n \"id\": \"do veniam\",\n \"deleted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1b03a662-3ff7-4c4f-bedf-15968553822f", + "id": "33f2c174-962c-4f93-9106-7e1e3ff0e040", "name": "Error", "originalRequest": { "url": { @@ -17077,7 +17129,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17085,7 +17137,7 @@ "event": [] }, { - "id": "6667c625-d9db-427b-8c3e-2394e5f1af2e", + "id": "9ffdeb46-87ba-4145-85b9-b5b4bb44f6e6", "name": "Create Domain", "request": { "name": "Create Domain", @@ -17134,7 +17186,7 @@ }, "response": [ { - "id": "ff00fb18-f158-4265-a12e-cd249158905a", + "id": "3644752c-d909-4b10-8311-b8adcbea87e6", "name": "Returns a domain object with details.", "originalRequest": { "url": { @@ -17181,12 +17233,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"commodo in dolore officia\",\n \"domain\": \"dolore ad\",\n \"error_redirect_link\": \"qui minim in\",\n \"status\": \"not_configured\",\n \"created_at\": \"ipsum eiusmod\",\n \"updated_at\": \"et esse nulla\"\n}", + "body": "{\n \"id\": \"laboris cupidatat nisi commodo\",\n \"domain\": \"quis Lorem ut\",\n \"error_redirect_link\": \"et amet esse quis\",\n \"status\": \"not_configured\",\n \"created_at\": \"sunt do\",\n \"updated_at\": \"velit dolore\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5e84a093-e84f-4da4-8007-fcb924dd6f3e", + "id": "9f470f09-4018-4951-bfc7-50a4c2837966", "name": "Error", "originalRequest": { "url": { @@ -17244,7 +17296,7 @@ } }, { - "id": "1ac548fe-48bd-423d-ac0f-d5f4345c8918", + "id": "45d33ebb-fca6-453a-867e-4676fbb5cdac", "name": "List all domains", "request": { "name": "List all domains", @@ -17298,7 +17350,7 @@ }, "response": [ { - "id": "e35292ef-0930-40f2-a189-d2947207db5d", + "id": "37518460-dbf9-49ff-885d-223ba35dedc2", "name": "Returns a list of all domains.", "originalRequest": { "url": { @@ -17349,12 +17401,12 @@ "value": "application/json" } ], - "body": "{\n \"object\": \"et eiusmod enim\",\n \"next_url\": \"nulla\",\n \"previous_url\": \"cillum sed in ea\",\n \"count\": 931305,\n \"total_count\": 79706909,\n \"data\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"domain\": {\n \"value\": \"\"\n },\n \"error_redirect_link\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"domain\": {\n \"value\": \"\"\n },\n \"error_redirect_link\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"object\": \"proident laborum Lorem i\",\n \"next_url\": \"velit sint minim aliqua\",\n \"previous_url\": \"aute laborum\",\n \"count\": -8709033,\n \"total_count\": 74846283,\n \"data\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"domain\": {\n \"value\": \"\"\n },\n \"error_redirect_link\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"domain\": {\n \"value\": \"\"\n },\n \"error_redirect_link\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "95511c97-e51a-4071-89d1-87179c46cea1", + "id": "6fb9bed1-f690-4134-a589-df3aa23dcd2c", "name": "Error", "originalRequest": { "url": { @@ -17405,7 +17457,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17413,7 +17465,7 @@ "event": [] }, { - "id": "e9aaf742-6dab-4f9d-ac93-50e552fc0a79", + "id": "f98abd9f-b55b-404a-8dd3-c9fc3f027465", "name": "Retrieve a link", "request": { "name": "Retrieve a link", @@ -17451,7 +17503,7 @@ }, "response": [ { - "id": "24d32936-b3f3-49b5-972f-5ed480f30e38", + "id": "771725d3-d975-4e57-8264-899601cd8b68", "name": "Returns a single link.", "originalRequest": { "url": { @@ -17494,12 +17546,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"velit cupidatat\",\n \"title\": \"proident quis ea eiusmod\",\n \"domain_id\": \"veniam commodo reprehenderit eiusmod sit\",\n \"redirect_link\": \"aliqua\",\n \"short_link\": \"incididunt elit et\",\n \"metadata\": \";ChVBZ8gFl;^?(knKat1W3nRB%K>9z~tPqL@luEtAUzLt,LE6PA~e=2#r$bI[;aTl3STWqrxs<,jlcI5v=Pi%vr#bA!My8bE'fH&BmR@BA?B+m_H2/}0h,caD~R-_VVh).*-=s<%szJW$8>@N8leo Q-Eg9oR63p;@Jb!G#7+&3?-J6Fv}L!ceRf@rRs8{^+D%5|7f&}:C<_C6fm3pk.^CF[U=?J5oe:`$vkZ4*q1I@4J,?3fD*K;SgJ~o*/I<=t_]oVlHUyExf}5igpOQ{,sp{gim$ G@3rOk{p'c`7#=;zHJ;Ma~#\",\n \"created_at\": \"quis sunt id proident dolor\",\n \"updated_at\": \"magna est dolore\"\n}", + "body": "{\n \"id\": \"adipisicing in in\",\n \"title\": \"mollit amet non\",\n \"domain_id\": \"nostrud exercitation et in\",\n \"redirect_link\": \"qui sint do\",\n \"short_link\": \"anim veniam Lorem\",\n \"metadata\": \"hnDG$)8_9D TauZ8=N+`.+wn4,|C4sOK4>*^<#SZ~0}G-M~S:OK&+7l-x#ts;3j8JS%4G'F36Os['6O=#m7h+8iSG3,X{,4K^VNx[&0/y!S3.VIpBVM%JT/X+AUnM{BA*ui>IX#;+9uO@@DhJX?G(JT7icx=i0O5l*hXQiT/2bqu;xC2~&];=5&(K#|6?,:w0;42-_qmg=Jjil2fq51}x>j/n322sI]L+O]0Np%PV%e(h qtu,C}O{E16 oL_PO-e-L:F4QB#sWH&no;M&XKn#m!$})LI[$PW_)4j$HK{6v1je-1JkDt&=ob2s3c MN/QD,F:,/^7j_F,L P,. 82%_U\",\n \"created_at\": \"consequat\",\n \"updated_at\": \"in do ad culpa nostrud\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "254fad87-9690-41a7-9122-a89d583e4d3a", + "id": "d6e19cd4-03c1-4157-a279-dce445bb5e4e", "name": "Error", "originalRequest": { "url": { @@ -17542,7 +17594,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17550,7 +17602,7 @@ "event": [] }, { - "id": "ea7059b8-9d80-4480-8240-0129b1807e8b", + "id": "9ec38ab1-d77a-4132-ab5d-866e9af52384", "name": "Update a Link", "request": { "name": "Update a Link", @@ -17607,14 +17659,14 @@ { "disabled": false, "key": "metadata", - "value": "i.)!p*!8b@AlkFJYkF{L#{x-ks9Q4oAd.qA4oyUvIiPF!I4hrc?LfCjr~e&LU~H`vBbri(D7t1kTw9,xi$|< vddGu~Z> hOAZdX*]M$}ZUY::Bs>PTz5!':T=$8Z7~C.7os({Kft(tNSM]-Ij+DC4a2%77*aK._*Sugzk2%:][gE< ;gs-C6T~vr$U2Y!5b5{.uO:viJ-d>Qq pv%Lb.T#r{>NcU8we._FOV-7<.I}3;9JP~^Oo1`dL]~%!u?RmLmEBZCtUNIW bbSh?25>VuW*~_A ['Ks2!@/a@B':[<(Av0!}5b*Td).XV" + "value": "nB`c]$d}s7%ZL0ikie_1So/1,5p&j?R=)Nm%" } ] } }, "response": [ { - "id": "5c08be82-9233-4306-810c-e89d67c38bc9", + "id": "0d226b58-4f84-4a92-a1e6-aab108d3dbfb", "name": "Returns the updated link.", "originalRequest": { "url": { @@ -17666,12 +17718,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"culpa nostrud\",\n \"title\": \"nostrud eiusmod Lorem minim\",\n \"domain_id\": \"officia minim irure est\",\n \"redirect_link\": \"\",\n \"short_link\": \"in enim sunt amet\",\n \"metadata\": \">`~rvl4 6M ]!@+U{:q})I]zri3n2Dg}edL.XxS:|Cifsd5V#72~~=GHsr(}@+xDxD(Fv&>1[>#\",\n \"short_link\": \"sint ex\",\n \"metadata\": \"qY[TzgM6PyzR o%c8uS*${xddb#}SFyM7CqO4,1^n{Yn.>/FzIKP1/~]X3U-K@_o.H9QC>; &W0;@m'&O+03?<.-NQ{0SQ,xNIwHE#h0^9TfJH2%!G=z<;~TJ&k2fjygYEks~^ZYE7tFZ_TRe$GMDP@Z;dNm[R;zy3vJ6B b6s_F|8JVrsVVy'j%2aXI;^4w&6jWa(*P6`reWck%aedOe-Vy)W<4m8}jd*YZj*5+ICj(n{;J!}Vy{6B%X8+Gc;-q\",\n \"created_at\": \"qui cupidatat\",\n \"updated_at\": \"officia amet pariatur quis ut\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5334c280-7a87-424f-b5c3-3ce70520d1b0", + "id": "38adc014-0fc7-4c56-96e0-189f2fa8a878", "name": "Error", "originalRequest": { "url": { @@ -17734,7 +17786,7 @@ } }, { - "id": "36ee89b6-4796-4335-8f5e-4fb12c088b17", + "id": "10564158-9ca1-46a4-8420-464863cb4749", "name": "Delete Link", "request": { "name": "Delete Link", @@ -17772,7 +17824,7 @@ }, "response": [ { - "id": "bebf55b2-1736-46a3-ac97-b02ad859dc9c", + "id": "d4dfe3f0-1137-462b-99cd-f23efba6a9db", "name": "Returns the deleted short link object", "originalRequest": { "url": { @@ -17815,12 +17867,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"incididunt cupidatat labor\",\n \"deleted\": false\n}", + "body": "{\n \"id\": \"Duis sit cillum\",\n \"deleted\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1d7b71ac-28a2-4837-9bf5-ff45bb6b402e", + "id": "009ebe2b-f5a4-4c24-94fe-124a58d32ef3", "name": "Error", "originalRequest": { "url": { @@ -17863,7 +17915,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17871,7 +17923,7 @@ "event": [] }, { - "id": "df1f24a3-39da-41eb-900e-0d1976efc91f", + "id": "d7f05a34-d0e4-44d6-ad37-20efe72da231", "name": "Create Link", "request": { "name": "Create Link", @@ -17931,14 +17983,14 @@ { "disabled": false, "key": "metadata", - "value": "s7HOdG{GZ><6TEB8y97q(IzSUrhg:9kc|*vuiFhlBJyeD`E TrcG|/[hiG~Ay=uH#j*7gk@=d8*N$@8mX,c+[olL=D3;>07/pSeZ]/i5[pzl_mx_d1AJcz$II5;wT:!h}r0wa+$|l$u`cqc/<`_TZUO6A14EPa--`.CC]lGhq[g'=J~;5fD3xvwd9qy)LRO]YdyT .oXRcVRH-exT[h{piai:sVjes9%@V/5L7%Lb)yf/aLY$T=+{/3db:JzZ|fdETI9/-M^zj1lTeq5O^mBgRB&u3+Lt$CJzmDk5PW4[pE1r#~Gb=A* +%S'U6DTx|W6?}zgXw)UErLJ:-~ o1!b[vC`syeRDKb!`GSLF);(*c}_Z8UN[ngN=V;f[ ]p%qADI67Ql2Ncz'QksA/v/4C%!]{6;3K}m+z9^PyK{70hpWW:PawB]A|hsGBfn7T>+W*/O!O:meS}ITo9wXl3,A{zd2/Wx ?j%tHmi_7>4X*]P0L=x:H90YF&~3_~kefesHCAj0p4S7S*yxf.t{;LrgD%EhoDoHLIJ6d#5e<7x.`fk,a1@_>PPi]uM!~\",\n \"short_link\": \"in enim sunt amet\",\n \"metadata\": \">`~rvl4 6M ]!@+U{:q})I]zri3n2Dg}edL.XxS:|Cifsd5V#72~~=GHsr(}@+xDxD(Fv&>1[>#\",\n \"short_link\": \"sint ex\",\n \"metadata\": \"qY[TzgM6PyzR o%c8uS*${xddb#}SFyM7CqO4,1^n{Yn.>/FzIKP1/~]X3U-K@_o.H9QC>; &W0;@m'&O+03?<.-NQ{0SQ,xNIwHE#h0^9TfJH2%!G=z<;~TJ&k2fjygYEks~^ZYE7tFZ_TRe$GMDP@Z;dNm[R;zy3vJ6B b6s_F|8JVrsVVy'j%2aXI;^4w&6jWa(*P6`reWck%aedOe-Vy)W<4m8}jd*YZj*5+ICj(n{;J!}Vy{6B%X8+Gc;-q\",\n \"created_at\": \"qui cupidatat\",\n \"updated_at\": \"officia amet pariatur quis ut\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b645da6a-2ca6-4bd0-b991-dbbb6035f5fe", + "id": "e7f71c29-0ea5-45d0-886f-7768f41802a6", "name": "Error", "originalRequest": { "url": { @@ -18066,7 +18118,7 @@ } }, { - "id": "3054624b-7eb4-4150-81a4-64e40618aef7", + "id": "10837c6e-189b-4205-b193-a113cfb61be1", "name": "List all links", "request": { "name": "List all links", @@ -18126,7 +18178,7 @@ }, "response": [ { - "id": "74f0bd03-af36-4040-97fc-562ae2b71109", + "id": "558943c9-433e-4ec1-a292-b2b9f40b379e", "name": "Returns the deleted link object.", "originalRequest": { "url": { @@ -18181,12 +18233,12 @@ "value": "application/json" } ], - "body": "{\n \"object\": \"do qui amet adipisicing\",\n \"next_url\": \"qui quis consectetur incididu\",\n \"previous_url\": \"laboris deserunt enim aute\",\n \"count\": -73987761,\n \"total_count\": 77647662,\n \"data\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"domain_id\": {\n \"value\": \"\"\n },\n \"redirect_link\": {\n \"value\": \"\"\n },\n \"short_link\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"domain_id\": {\n \"value\": \"\"\n },\n \"redirect_link\": {\n \"value\": \"\"\n },\n \"short_link\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"object\": \"est do cupidatat\",\n \"next_url\": \"velit minim\",\n \"previous_url\": \"ex officia consequat cupidatat\",\n \"count\": 7693196,\n \"total_count\": -33460274,\n \"data\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"domain_id\": {\n \"value\": \"\"\n },\n \"redirect_link\": {\n \"value\": \"\"\n },\n \"short_link\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"title\": {\n \"value\": \"\"\n },\n \"domain_id\": {\n \"value\": \"\"\n },\n \"redirect_link\": {\n \"value\": \"\"\n },\n \"short_link\": {\n \"value\": \"\"\n },\n \"metadata\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "282d6bd8-ef5b-4d00-a70f-8e4932a53e20", + "id": "9f39d94d-e1ad-4519-9d0e-e6e5b07fafba", "name": "Error", "originalRequest": { "url": { @@ -18241,7 +18293,7 @@ "value": "application/json" } ], - "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"invalid_bank_account_verification\"\n }\n}", + "body": "{\n \"error\": {\n \"message\": \"Rate limit exceeded. Please wait 5 seconds and try your request again.\",\n \"status_code\": null,\n \"code\": \"unrecognized_endpoint\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -18252,7 +18304,7 @@ "event": [] }, { - "id": "652beda5-c30d-4344-a575-e7458b0605ff", + "id": "0aa24b34-5978-439a-a569-40bacaa014df", "name": "US Autocompletions", "description": { "content": "Given partial address information, this endpoint returns up to 10 address suggestions.
back to top
\n## Autocompletion Test Env\nYour test API key does not autocomplete US addresses and is used to simulate behavior. With your test API key, requests with specific values for `address_prefix` return predetermined values. When `address_prefix` is set to:\n- `0 suggestions` - Returns no suggestions - `[PRIMARY NUMBER] s[uggestion]` - Returns a maximum of ten predefined suggested addresses.\n `[PRIMARY NUMBER]` does not have to be a valid primary number when sending a test request.\n Each additional letter in `suggestion` reduces the number of suggestions by one (e.g.\n `1 su` returns 9 suggested addresses). `[PRIMARY NUMBER]` does not affect the number of\n suggestions returned.\n\nCity and state filters work as expected and filter the list of predetermined suggested addresses.\nSee the `test` request & response examples under [Autocomplete Examples](#operation/autocompletion) within the \"Autocomplete a partial address\" section in US Autocompletions.
back to top
\n", @@ -18260,7 +18312,7 @@ }, "item": [ { - "id": "87ad38f9-446a-4c33-b9d8-1db2ce4b52ce", + "id": "4c20516a-fb5c-4bfb-a183-d4c0048dd052", "name": "Autocomplete", "request": { "name": "Autocomplete", @@ -18341,7 +18393,7 @@ }, "response": [ { - "id": "882e9a91-5d7b-4cda-ac11-911c7fe6f73b", + "id": "608dd921-c4f6-408e-aa2f-614ce307f23a", "name": "Returns a US autocompletion object.", "originalRequest": { "url": { @@ -18456,7 +18508,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6ccc5c06-7e21-4940-987d-ee600856f5ab", + "id": "5330fd6d-7a86-4ee9-b18c-8a73209fd1db", "name": "Error", "originalRequest": { "url": { @@ -18562,7 +18614,7 @@ "event": [] }, { - "id": "38d32d5d-1673-484a-a870-46cfd477f556", + "id": "e654eb59-657d-4574-8d05-e6da4661f7cf", "name": "US Verification Types", "description": { "content": "These are detailed definitions for various fields in the [US verification object](#operation/us_verification).\n\n

ZIP Code Types - components[zip_code_type]

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
standardThe default ZIP code type. Used when none of the other types apply.
po_boxThe ZIP code contains only PO Boxes.
uniqueThe ZIP code is uniquely assigned to a single organization (such as a government agency) that receives a large volume of mail.
militaryThe ZIP code contains military addresses.
empty stringA match could not be made with the provided inputs.
\n\n

Record Types - components[record_type]

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
streetThe default address type.
highriseThe address is a commercial building, apartment complex, highrise, etc.
firmThe address is of an organizational entity which receives a minimum number of mailpieces per day.
po_boxThe address is a PO Box.
rural_routeThe address exists on a Rural Route. This is an older system of mail delivery which is still used in some parts of the country.
general_deliveryThe address is part of the USPS General Delivery service, which allows individuals without permanent addresses to receive mail.
empty stringA match could not be made with the provided inputs.
\n\n

Carrier Route Types - components[carrier_route_type]

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
city_deliveryThe default carrier route type. Used when none of the other types apply.
rural_routeThe carrier route is a Rural Route. This is an older system of mail delivery which is still used in some parts of the country.
highway_contractThe 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.
po_boxThe carrier route consists of PO Boxes.
general_deliveryThe carrier route is part of the USPS General Delivery service, which allows individuals without permanent addresses to receive mail.
empty stringA match could not be made with the provided inputs.
\n\n

DPV Footnotes - deliverability_analysis[dpv_footnotes]

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
AASome parts of the address (such as the street and ZIP code) are valid.
A1The address is invalid based on given inputs.
BBThe address is deliverable.
CCThe address is deliverable by removing the provided secondary unit designator.
TAThe address is deliverable by dropping a trailing alphabet from the primary number.
IAThe address is an Informed Address. The recipient and the street address is replaced with a special code provided by the USPS.
N1The address is deliverable but is missing a secondary information (apartment, unit, etc).
F1The address is a deliverable military address.
G1The address is a deliverable General Delivery address. General Delivery is a USPS service which allows individuals without permanent addresses to receive mail.
U1The 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.
C1The primary number was confirmed whereas the secondary number is unconfirmed and required to be deliverable.
M1The primary number is missing.
M3The primary number is invalid.
P1PO Box, Rural Route, or Highway Contract box number is missing.
P3PO Box, Rural Route, or Highway Contract box number is invalid.
PBThe address is identified as PO Box street address.
R1The address matched to a CMRA and private mailbox information is not present.
R7The address matched to a Phantom Carrier Route (carrier_route of R777), which corresponds to physical addresses that are not eligible for delivery.
RRThe address matched to a CMRA and private mailbox information is present.
\n
back to top
\n", @@ -18572,7 +18624,7 @@ "event": [] }, { - "id": "c655738b-3b47-4626-9efd-2b62845d63c2", + "id": "6e9bd3b2-da0e-4ce4-8da1-c279d2786d5e", "name": "US Verifications", "description": { "content": "Validate, automatically correct, and standardize the addresses in your\naddress book based on USPS's Coding Accuracy Support System (CASS).\n
\n
back to top
\n\n## US Verifications Test Env\n\nWhen verifying US addresses, you'll likely want to test against a wide array of addresses to\nensure you're handling responses correctly. With your test API key, requests that use specific\nvalues for `address` or `primary_line` and (if using `primary_line`) an arbitrary five digit\nnumber for `zip_code` (e.g. \"11111\") let you explore the responses to many types of addresses:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ADDRESS TYPE FOR SAMPLE RESPONSEDELIVERABILITYSET primary_line OR address TO
Commercial highrisedeliverablecommercial highrise
Residential highrisedeliverableresidential highrise
Residential housedeliverableresidential house
PO Boxdeliverablepo box
Rural routedeliverablerural route
Puerty Rico address w/ urbanizationdeliverablepuerto rico
Military addressdeliverablemilitary
Department of statedeliverabledepartment of state
Generic deliverabledeliverabledeliverable
Missing a suite numberdeliverable_missing_unitmissing unit
Suite number doesn't existdeliverable_incorrect_unitincorrect unit
Residential house with unnecessary suite numberdeliverable_unnecessary_unitunnecessary unit
Undeliverable and block matchedundeliverableundeliverable block match
Undeliverable and no block matchedundeliverableundeliverable no match
\n\nSee the `test` request & response examples under [US Verification Examples](#operation/us_verification) within the\n\"Verify a US or US territory address\" section in US Verifications.\n\nYou can rely on the response from these examples generally matching the response you'd see in the live environment with an\naddress of that type (excluding the `recipient` field).\n\nThe test API key does not perform any verification, automatic correction, or standardization for addresses. If you wish to\ntry these features out, use our live demo or the free plan (see our pricing for details).\n
back to top
\n", @@ -18580,7 +18632,7 @@ }, "item": [ { - "id": "3728274e-bba6-410b-b124-f8a2050e8d6f", + "id": "4aa32dbb-db5a-4b10-9f6b-d4a283ee11ac", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -18632,7 +18684,7 @@ }, "response": [ { - "id": "bb274bc5-09e0-4e47-be2b-ba55d8472728", + "id": "2512e714-a48d-48c3-b6c7-48481010a1e5", "name": "Returns a list of US verification objects.", "originalRequest": { "url": { @@ -18717,7 +18769,7 @@ "_postman_previewlanguage": "json" }, { - "id": "de03c554-bd11-4cde-b369-9b8a863b2973", + "id": "8378f000-b71c-41a7-be89-5152416d7649", "name": "Error", "originalRequest": { "url": { @@ -18790,7 +18842,7 @@ } }, { - "id": "3c5bbae7-c884-4867-9b7f-9b4085a566ae", + "id": "355908ad-89bd-4261-8ef0-fc893dc2bc14", "name": "Single Verify", "request": { "name": "Single Verify", @@ -18870,7 +18922,7 @@ }, "response": [ { - "id": "799382ae-2b07-43df-b90e-672a45b263c2", + "id": "00277495-4414-49e3-bb2a-c7b262fca76c", "name": "Returns a US verification object.", "originalRequest": { "url": { @@ -18956,7 +19008,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2968ab75-db83-4249-b0e9-7e5deb137702", + "id": "bc93ea80-9dca-4ddf-a7e6-83186fea42e7", "name": "Error", "originalRequest": { "url": { @@ -19033,7 +19085,7 @@ "event": [] }, { - "id": "c7e150f5-8fec-4312-9f5a-c4338279fdd7", + "id": "670924c2-9238-4dfa-b924-5ad8d6819203", "name": "Versioning and Changelog", "description": { "content": "### API Versioning\n\nWhen backwards-incompatible changes are made to the API, a new dated version\nis released. The latest version of the API is version **2024-01-01**. \nAll versions prior to, and inclusive of, 2019-02-11 have been sunsetted. You can\nview your version and upgrade to the latest version in your\nDashboard Settings. You will\nonly need to specify a version if you would like to test a newer version of\nthe API without doing a full upgrade. The API will return an error if a\nversion older than your current one is passed in.\n\n### Example Request\n\n```bash\n curl https://api.lob.com/v1/addresses \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -H \"Lob-Version: 2024-01-01\"\n```\n\n### Specification Versioning\nYou might be wondering why our API and specification use different versioning schemes.\nLob's API predates our specification and follows the Stripe versioning\napproach. This works well to manage backwards-incompatible changes to our API.\n\nFor our API specification (used to create this documentation), we've chosen semantic\nversioning. This versioning reflects the backward-compatible\nchanges that do not require a versioning of Lob's API.\n\nLob's API specification will be used to generate artifacts like documentation, client SDKs,\nand other developer tooling. Semantic versioning of our specification will inform how we\nversion those artifacts like SDKs. It is helpful to know the version of a specification\nused to produce an artifact in order reference the specification release notes.\n\n\n### Changelog\n View our Changelog here.\n", @@ -19043,7 +19095,7 @@ "event": [] }, { - "id": "fb46c6c8-e5f8-402b-9852-2741a85de163", + "id": "08e2692c-69db-4961-ba54-7edcc0309d6a", "name": "Webhooks", "description": { "content": "Webhooks are an easy way to get notifications on events happening asynchronously\nwithin Lob's architecture. For example, when a postcard gets a \"Processed For\nDelivery\" tracking event, an event object of type `postcard.processed_for_delivery`\nwill be created. If you are subscribed to that event type in that Environment\n(Test vs. Live), Lob will send that event to any URLs you've specified via an\nHTTP POST request. In Live mode, you can only have as many webhooks as allotted\nin your current Print & Mail Edition.\nThere is no limit in Test mode.\nYou can view and create webhooks on the\nLob Dashboard, as well as view your events.\nSee our Webhooks Integration Guide for more\ndetails on how to integrate. Please see the full list of event types available for\nsubscription here.\n
back to top
\n", @@ -19053,7 +19105,7 @@ "event": [] }, { - "id": "926319ef-3016-41e9-ae54-05e997df701a", + "id": "a3d1b709-9569-4003-8ea2-f57eea50d72b", "name": "Zip Lookups", "description": { "content": "Find a list of cities, states and associated information about a US ZIP code.
back to top
\n", @@ -19061,7 +19113,7 @@ }, "item": [ { - "id": "384b7b7a-20bb-49a7-8026-e8076744d844", + "id": "c8e51319-5538-4b42-ba46-e7dfa9358326", "name": "Lookups", "request": { "name": "Lookups", @@ -19105,7 +19157,7 @@ }, "response": [ { - "id": "c4fffe02-8796-4451-a66f-81c8069dfe20", + "id": "16460864-1dd9-47cf-b126-3c967874078d", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -19175,7 +19227,7 @@ "_postman_previewlanguage": "json" }, { - "id": "53d3f476-a710-4b6b-8e89-f7398e766d4f", + "id": "1697ebc3-5e63-4078-9d8a-ba8ec51941b1", "name": "Error", "originalRequest": { "url": { @@ -19236,7 +19288,7 @@ "event": [] }, { - "id": "fba08f5f-9960-47e9-829c-4fc55504f4be", + "id": "4ddfc094-38af-4906-8cdd-4a330adec839", "name": "Accounts", "description": { "content": "", @@ -19244,7 +19296,7 @@ }, "item": [ { - "id": "2e94c164-5bc1-40b9-9be0-60f7b88c1c54", + "id": "aedd0b92-68ec-4efd-abb2-97dfd724951d", "name": "Get Lob Credits Balance", "request": { "name": "Get Lob Credits Balance", @@ -19273,7 +19325,7 @@ }, "response": [ { - "id": "e7b2be61-f868-4fce-9187-5000ef903e6d", + "id": "ab7c30e8-d6d2-4ed8-a4b1-bc0f301d535a", "name": "Returns a lob_credits_balance object.", "originalRequest": { "url": { @@ -19318,7 +19370,7 @@ "event": [] }, { - "id": "4eab0f69-fde4-44b6-80dd-421b29613940", + "id": "b4b37904-624d-45b9-ba1f-ecd3704b5ac9", "name": "Lob Credits", "description": { "content": "", @@ -19326,7 +19378,7 @@ }, "item": [ { - "id": "93d56614-0b06-4eab-bc46-c9da9520eb41", + "id": "9b30affc-e690-4a45-8489-2ab3f7d8cfc6", "name": "Get Lob Credits Balance", "request": { "name": "Get Lob Credits Balance", @@ -19355,7 +19407,7 @@ }, "response": [ { - "id": "d6695a7f-876d-4bee-ab4a-48667db52ca6", + "id": "b46bbd7a-f6c2-4b96-a3ca-60126914b5aa", "name": "Returns a lob_credits_balance object.", "originalRequest": { "url": { @@ -19400,7 +19452,7 @@ "event": [] }, { - "id": "58c4feb5-c334-48d9-bc3a-a80857d1d6bd", + "id": "ac4bd595-ecba-4921-809a-27c6e93ee4cf", "name": "Booklets", "description": { "content": "", @@ -19408,7 +19460,7 @@ }, "item": [ { - "id": "68ed3dea-8cec-4922-b8cd-05e7856e0a5b", + "id": "792472e3-51ed-44a7-953a-4fecbc335034", "name": "Retrieve", "request": { "name": "Retrieve", @@ -19446,7 +19498,7 @@ }, "response": [ { - "id": "d6570262-1fbb-45f9-8fb6-d8a5ea7cc480", + "id": "80a79132-b694-44c1-bd8f-b696152861b5", "name": "Returns a booklet object", "originalRequest": { "url": { @@ -19494,7 +19546,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0232bd64-fd6f-43df-8606-1ac5b6baeb18", + "id": "e1cbc2a5-4793-4cce-9c46-bb059d5f4d9a", "name": "Error", "originalRequest": { "url": { @@ -19545,7 +19597,7 @@ "event": [] }, { - "id": "84ec859a-fa2d-4c5f-a259-2d8767dfa32d", + "id": "7b5f6e9e-bfde-4f9e-afcf-545daa77594f", "name": "Delete", "request": { "name": "Delete", @@ -19583,7 +19635,7 @@ }, "response": [ { - "id": "bdd2f7e9-6bac-4f3e-bfb0-79527bd1852c", + "id": "66e1e793-afac-4403-9898-229617a36c3c", "name": "Deleted", "originalRequest": { "url": { @@ -19631,7 +19683,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ffc10de1-7deb-48d7-acda-dfdd6a305e78", + "id": "67b2ce69-8329-45f6-b327-aef52aab5557", "name": "Error", "originalRequest": { "url": { @@ -19682,7 +19734,7 @@ "event": [] }, { - "id": "92f75495-2660-4544-b672-9cfb61c89131", + "id": "6eaf038e-90b2-4319-9920-976d0586d438", "name": "List", "request": { "name": "List", @@ -19730,7 +19782,25 @@ }, { "disabled": false, - "key": "date_created[adipisicing2]", + "key": "date_created[eiusmod5cd]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -19778,7 +19848,7 @@ }, "response": [ { - "id": "c822125c-6ca4-4663-991d-2343d2331b9f", + "id": "719a8470-4a7a-42e5-bc71-2b88d391ffb0", "name": "A dictionary with a data property that contains an array of up to `limit` booklets. Each entry in the array is a separate booklet. The previous and next page of booklets can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively. If no more booklets are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -19810,15 +19880,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -19870,7 +19936,7 @@ "_postman_previewlanguage": "json" }, { - "id": "17ba0a20-3e4e-4eb9-8449-c9f6178fdffe", + "id": "f8e6385c-2b65-4f9e-b25b-dbeee853936d", "name": "Error", "originalRequest": { "url": { @@ -19902,15 +19968,11 @@ "value": "" }, { - "key": "date_created[enim8]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[velit3]", - "value": "" - }, - { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -19965,7 +20027,7 @@ "event": [] }, { - "id": "f3306893-8766-4334-9cda-940072d88d07", + "id": "0d487ebd-9fa8-434d-ba0a-56ab48a2646f", "name": "Create", "request": { "name": "Create", @@ -20049,7 +20111,7 @@ { "disabled": false, "key": "metadata", - "value": "+K>;xrV2&R;ksNm|Hq)DXPi01}S)^iQhI=lAoIaX[r5CGfndl1,A>Sq}@Sp$'hXh:s[<$RnpBP@{axcj'.XU1HD9kuQ~K:!%obXjtDGw?I;=uH.#UBa*;onD Q.5_HP(QR*nP=}%#dgbRGxc+[{eT]", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[consecteturc97]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[quis1d3]", + "value": "", + "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." + }, + { + "disabled": false, + "key": "date_created[id_9]", "value": "", "description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤." }, @@ -20969,7 +21049,7 @@ }, "response": [ { - "id": "9319b25c-ec9d-420c-b1a6-cd8c45d645e6", + "id": "3a34fced-3fe1-4793-a2ca-4fed25119efd", "name": "A dictionary with a data property that contains an array of up to `limit` snap_packs. Each entry in the array is a separate self_mailer. The previous and next page of snap_packs can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.
If no more snap_packs are available beyond the current set of returned results, the `next_url` field will be empty.", "originalRequest": { "url": { @@ -21001,15 +21081,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -21061,7 +21137,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f25c6fb8-8175-4098-aeda-daad67642ec7", + "id": "4bf998b4-2c10-4e28-86fe-6697f7f65dc1", "name": "Error", "originalRequest": { "url": { @@ -21093,15 +21169,11 @@ "value": "" }, { - "key": "date_created[enim8]", - "value": "" - }, - { - "key": "date_created[velit3]", + "key": "date_created[fugiate77]", "value": "" }, { - "key": "date_created[aliqua_2]", + "key": "date_created[pariatur_8]", "value": "" }, { @@ -21156,7 +21228,7 @@ "event": [] }, { - "id": "65617ed3-5752-41ac-add7-56c3cd28fd0f", + "id": "7df845a9-3626-47d5-b9f6-37e9ae048a7d", "name": "Create", "request": { "name": "Create", @@ -21291,7 +21363,7 @@ }, "response": [ { - "id": "cc4a24c8-441c-436f-b864-31d0b29e5a8a", + "id": "57660630-823e-41ec-b75c-0d1e2f972849", "name": "Returns a snap_pack object", "originalRequest": { "url": { @@ -21462,7 +21534,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aa738529-3266-427e-8bbf-31575d1a0fa4", + "id": "c883ecd3-3f12-4df0-ad1f-46de1471d4bc", "name": "Error", "originalRequest": { "url": { @@ -21646,7 +21718,7 @@ ] }, "info": { - "_postman_id": "83c57b1e-d6c6-4c8c-85bb-33be0b8a394a", + "_postman_id": "c1de1fea-96f5-4708-9ab2-265fe7719290", "name": "Lob", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/docs/index.html b/docs/index.html index a6157baf..b2738683 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3007,7 +3007,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

Lob (1.20.1)

Lob Developer Experience: lob-openapi@lob.com URL: https://support.lob.com/ License: MIT Terms of Service

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">

Lob (1.20.2)

Lob Developer Experience: lob-openapi@lob.com URL: https://support.lob.com/ License: MIT Terms of Service

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.

Introduction

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 @@

3. Learn more

Array of objects or null (tracking_event_normal)

An array of tracking_event objects ordered by ascending time. Will not be populated for postcards created in test mode.

campaign_id
string or null (campaign_id) ^(cmp|camp)_[a-zA-Z0-9]+$

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_.

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 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3363,7 +3363,7 @@

    3. Learn more

adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object)))

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.

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 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

Responses

Response Headers
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 time. Will not be populated for postcards created in test mode.

campaign_id
string or null (campaign_id) ^(cmp|camp)_[a-zA-Z0-9]+$

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_.

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 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3424,7 +3424,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: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. These settings only apply on HTML templates and not on QR code redirect URLs.

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 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.

-
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

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 send_date.

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 time. Not populated in test mode.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3526,11 +3526,11 @@

    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: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. These settings only apply on HTML templates and not on QR code redirect URLs.

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 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.

-
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object)))

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.

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 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

Responses

Response Headers
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: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. These settings only apply on HTML templates and not on QR code redirect URLs.

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 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.

-
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
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 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

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 send_date.

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 time. Not populated in test mode.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3614,7 +3614,7 @@

    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 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_.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3721,7 +3721,7 @@

    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 A4 and us_legal letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 and us_legal letter size.

size
string (ltr_size)
Default: "us_letter"
Enum: "us_letter" "us_legal"

Specifies the size of the letter. It accepts two values us_letter and us_legal. If the Lob-Version header in the request is set to 2024-01-01 and above, the size property is automatically included with the default value of us_letter, unless explicitly specified.

Please note that attempting to include the size property in the request with the Lob-Version header predating to 2024-01-01 will result in an error.

Responses

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 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_.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -3973,7 +3973,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 snap pack.

object
string
Default: "snap_pack"
Value: "snap_pack"

Value is resource type.

Array of objects (tracking_event_normal)

An array of tracking events ordered by ascending time. Not populated in test mode.

-
fsc
boolean
Default: false

Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.

+
fsc
boolean
Default: false

Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -4091,7 +4091,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 snap pack.

object
string
Default: "snap_pack"
Value: "snap_pack"

Value is resource type.

Array of objects (tracking_event_normal)

An array of tracking events ordered by ascending time. Not populated in test mode.

-
fsc
boolean
Default: false

Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.

+
fsc
boolean
Default: false

Contact support@lob.com or your account contact to learn more. Not available for snap_pack currently.

status
string (status)
Enum: "processed" "rendered" "failed"

A string describing the PDF render status:

  • processed - the rendering process is currently in progress.
    • @@ -4130,7 +4130,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 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_.

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:

  • processed - the rendering process is currently in progress.
    • @@ -4208,7 +4208,7 @@

    3. Learn more

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 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.

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 A4 and us_legal letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 and us_legal letter size.

source_material
string (booklet_source_material)
Default: "60# Gloss Text"
Value: "60# Gloss Text"

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.

Responses

Response Headers
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 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_.

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:

  • processed - the rendering process is currently in progress.
    • @@ -5285,12 +5285,11 @@

    Example Create Request using Sen

total_count
required
integer

Indicates the total number of records. Provided when the request specifies an "include" query parameter

next_url
string or null

Url of next page of items in list.

prev_url
string or null

Url of previous page of items in list.

-

Request samples 

curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9/report \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "ex_6a94fe68fd151e0f8",
  • "dateCreated": "2021-07-06T22:51:42.838Z",
  • "dateModified": "2022-07-06T22:51:42.838Z",
  • "deleted": false,
  • "s3Url": null,
  • "state": "in_progress",
  • "type": "failures",
  • "uploadId": "upl_71be866e430b11e9"
}

Retrieve Export

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.

+

Response samples

Content type
application/json
{
  • "id": "ex_6a94fe68fd151e0f8",
  • "dateCreated": "2021-07-06T22:51:42.838Z",
  • "dateModified": "2022-07-06T22:51:42.838Z",
  • "deleted": false,
  • "s3Url": null,
  • "state": "in_progress",
  • "type": "failures",
  • "uploadId": "upl_71be866e430b11e9"
}

Retrieve Export

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.

Authorizations:
basicAuth
path Parameters
upl_id
required
string (upl_id) ^upl_[a-zA-Z0-9]+$

ID of the upload

ex_id
required
string (ex_id) ^ex_[a-zA-Z0-9]+$

ID of the export

Responses

type
required
string
Enum: "all" "failures" "successes"

The export file type, which can be all, failures or successes.

uploadId
required
string (upl_id) ^upl_[a-zA-Z0-9]+$

Unique identifier prefixed with upl_.

Request samples 

curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9/exports/ex_6a94fe68fd151e0f8 \
+
https://api.lob.com/v1/uploads/{upl_id}/exports/{ex_id}

Request samples 

curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9/exports/ex_6a94fe68fd151e0f8 \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "ex_6a94fe68fd151e0f8",
  • "dateCreated": "2021-07-06T22:51:42.838Z",
  • "dateModified": "2022-07-06T22:51:42.838Z",
  • "deleted": false,
  • "s3Url": null,
  • "state": "in_progress",
  • "type": "failures",
  • "uploadId": "upl_71be866e430b11e9"
}

Informed Delivery Campaign

The Informed Delivery campaigns API allows you to create and view Informed Delivery campaigns.

+

Response samples

Content type
application/json
{
  • "id": "ex_6a94fe68fd151e0f8",
  • "dateCreated": "2021-07-06T22:51:42.838Z",
  • "dateModified": "2022-07-06T22:51:42.838Z",
  • "deleted": false,
  • "s3Url": null,
  • "state": "in_progress",
  • "type": "failures",
  • "uploadId": "upl_71be866e430b11e9"
}

Informed Delivery Campaign

The Informed Delivery campaigns API allows you to create and view Informed Delivery campaigns.

back to top

List

List Informed Delivery campaigns

Authorizations:
basicAuth

Responses

total_count
integer

Indicates the total number of records. Provided when the request specifies an "include" query parameter

Array of objects (response)

list of Informed Delivery campaigns

Request samples 

curl https://api.lob.com/v1/informed_delivery_campaign \
+
https://api.lob.com/v1/informed_delivery_campaigns

Request samples 

curl https://api.lob.com/v1/informed_delivery_campaign \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 2
}

Create

Creates a new Informed Delivery campaign

+

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 2
}

Create

Creates a new Informed Delivery campaign

Authorizations:
basicAuth
Request Body schema: multipart/form-data
quantity
required
integer [ 2 .. 10000000 ]

The number of mail pieces that will be part of this Informed Delivery campaign. USPS requires that IMB Codes are in sequence, so any mail pieces sent beyond this quantity will be rejected.

ride_along_image
required
object

JPG Image. Maximum file size is 200 KBs. Maximum pixel size is 300 pixels wide x 200 pixels high

ride_along_url
required
string [ 10 .. 255 ] characters ^https:\/\/.{5,247}$

To qualify as part of a promotion, the base domain must match the domain used to register the promotion. @@ -5364,7 +5363,7 @@

Example Create Request using Sen

service_request_number
required
string or null

The USPS promotion service request number used to create this campaign (if there was one used).

Request samples 

curl --request POST \
+
https://api.lob.com/v1/informed_delivery_campaigns

Request samples 

curl --request POST \
   --url https://api.lob.com/v1/informed_delivery_campaigns \
   -u <YOUR API KEY>: \
   --header 'Content-Type: multipart/form-data' \
@@ -5373,7 +5372,7 @@ 
Example Create Request using Sen
   --form quantity=2 \
   --form start_date=2024-01-01 \
   --form status=pending_approval
-

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

Retrieve

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

+

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

Retrieve

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

Authorizations:
basicAuth
path Parameters
usps_campaign_id
required
string (usps_campaign_id) ^[0-9]+$
Example: 1200772869

usps_campaign_id of the Informed Delivery campaign

Responses

Response Schema: application/json
id
required
string (infd_id) ^infd_[a-zA-Z0-9]+$

Unique identifier prefixed with infd_.

@@ -5405,9 +5404,9 @@

Example Create Request using Sen

service_request_number
required
string or null

The USPS promotion service request number used to create this campaign (if there was one used).

Request samples 

curl https://api.lob.com/v1/informed_delivery_campaign/1200772869 \
+
https://api.lob.com/v1/informed_delivery_campaigns/{usps_campaign_id}

Request samples 

curl https://api.lob.com/v1/informed_delivery_campaign/1200772869 \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

Update

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

+

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

Update

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

Authorizations:
basicAuth
path Parameters
usps_campaign_id
required
string (usps_campaign_id) ^[0-9]+$
Example: 1200772869

usps_campaign_id of the Informed Delivery campaign

Request Body schema: multipart/form-data
quantity
integer [ 2 .. 10000000 ]

The number of mail pieces that will be part of this Informed Delivery campaign. USPS requires that IMB Codes are in sequence, so any mail pieces sent beyond this quantity will be rejected.

status
string
Value: "approved"

After setting an Informed Delivery campaign to “approved” said campaign will activate, and you can start sending mail using it. @@ -5454,10 +5453,10 @@

Example Create Request using Sen

Request samples 

curl -X PATCH https://api.lob.com/v1/creatives/crv_2a3b096c409b32c \
+
https://api.lob.com/v1/informed_delivery_campaigns/{usps_campaign_id}

Request samples 

curl -X PATCH https://api.lob.com/v1/creatives/crv_2a3b096c409b32c \
   -u <YOUR API KEY>: \
   -d '{"status":"approved"}'
-

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

US Verifications

Validate, automatically correct, and standardize the addresses in your +

Response samples

Content type
application/json
{
  • "id": "infd_234g5324g324g23",
  • "object": "informed_delivery_campaign",
  • "account_id": "xxxxxxxxxxxxxxxxxxxx",
  • "quantity": 20,
  • "usps_campaign_id": "1234567890",
  • "usps_title": "Campaign: 1a1a1a1a-9657-423b-b3c7-2",
  • "start_date": "2024-08-31T00:00:00.000Z",
  • "end_date": "2024-10-15T00:00:00.000Z",
  • "start_serial": 3183487,
  • "end_serial": 3183506,
  • "ride_along_url": "https://www.lob.com",
  • "ride_along_image_s3_link": "https://lob-assets.com/informed-delivery/infd_234g5324g324g23_ride_along.jpg",
  • "representative_image_s3_link": null,
  • "status": "approved",
  • "date_created": "2024-08-30T23:30:02.980Z",
  • "date_modified": "2024-08-30T23:30:05.027Z",
  • "mode": "live",
  • "lob_campaign_id": null,
  • "deleted": false,
  • "campaign_code": "1a1a1a1a-9657-423b-b3c7-2+Code",
  • "brand_name": "Lob",
  • "service_request_number": null
}

US Verifications

Validate, automatically correct, and standardize the addresses in your address book based on USPS's Coding Accuracy Support System (CASS).

back to top
@@ -5559,7 +5558,7 @@

Example Create Request using Sen

Response Schema: application/json
required
Array of us_verification (object) or error (object)
errors
required
boolean

Indicates whether any errors occurred during the verification process.

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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 for details.

+
https://api.lob.com/v1/bulk/us_verifications

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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 for details.

Authorizations:
basicAuth
query Parameters
case
string
Default: "upper"
Enum: "upper" "proper"

Casing of the verified address. Possible values are upper and proper for uppercased (e.g. "PO BOX") and proper-cased (e.g. "PO Box"), respectively. Only affects recipient, primary_line, secondary_line, urbanization, and last_line. Default casing is upper.

Request Body schema:
One of
Any of
city
required
string <= 200 characters

The name of the city. city and state are required if no zip_code is passed.

state
required
string <= 50 characters

The ISO 3166-2 two letter code or subdivision name for the state. city and state are required if no zip_code is passed.

@@ -5625,7 +5624,7 @@

Example Create Request using Sen

object
string
Default: "us_verification"
Value: "us_verification"

Value is resource type.

Request samples

Content type
Example
{
  • "primary_line": "210 King Street",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
Example
{
  • "id": "us_ver_c7cb63d68f8d6",
  • "recipient": "LOB.COM",
  • "primary_line": "210 KING ST",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1702",
  • "deliverability": "deliverable",
  • "valid_address": true,
  • "components": {
    • "primary_number": "210",
    • "street_predirection": "",
    • "street_name": "KING",
    • "street_suffix": "ST",
    • "street_postdirection": "",
    • "secondary_designator": "",
    • "secondary_number": "",
    • "pmb_designator": "",
    • "pmb_number": "",
    • "extra_secondary_designator": "",
    • "extra_secondary_number": "",
    • "city": "SAN FRANCISCO",
    • "state": "CA",
    • "zip_code": "94107",
    • "zip_code_plus_4": "1702",
    • "zip_code_type": "standard",
    • "delivery_point_barcode": "941071702108",
    • "address_type": "commercial",
    • "record_type": "street",
    • "default_building_address": false,
    • "county": "SAN FRANCISCO",
    • "county_fips": "06075",
    • "carrier_route": "C032",
    • "carrier_route_type": "city_delivery",
    • "po_box_only_flag": "N",
    • "latitude": 37.77597542841264,
    • "longitude": -122.3929557343685
    },
  • "deliverability_analysis": {
    • "dpv_confirmation": "Y",
    • "dpv_cmra": "N",
    • "dpv_vacant": "N",
    • "dpv_active": "Y",
    • "dpv_inactive_reason": "",
    • "dpv_throwback": "N",
    • "dpv_non_delivery_day_flag": "N",
    • "dpv_non_delivery_day_values": "",
    • "dpv_no_secure_location": "N",
    • "dpv_door_not_accessible": "N",
    • "dpv_footnotes": [
      ],
    • "ews_match": false,
    • "lacs_indicator": "",
    • "lacs_return_code": "",
    • "suite_return_code": ""
    },
  • "lob_confidence_score": {
    • "score": 100,
    • "level": "high"
    },
  • "object": "us_verification"
}

US Verification Types

These are detailed definitions for various fields in the US verification object.

+
https://api.lob.com/v1/us_verifications

Request samples

Content type
Example
{
  • "primary_line": "210 King Street",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
Example
{
  • "id": "us_ver_c7cb63d68f8d6",
  • "recipient": "LOB.COM",
  • "primary_line": "210 KING ST",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1702",
  • "deliverability": "deliverable",
  • "valid_address": true,
  • "components": {
    • "primary_number": "210",
    • "street_predirection": "",
    • "street_name": "KING",
    • "street_suffix": "ST",
    • "street_postdirection": "",
    • "secondary_designator": "",
    • "secondary_number": "",
    • "pmb_designator": "",
    • "pmb_number": "",
    • "extra_secondary_designator": "",
    • "extra_secondary_number": "",
    • "city": "SAN FRANCISCO",
    • "state": "CA",
    • "zip_code": "94107",
    • "zip_code_plus_4": "1702",
    • "zip_code_type": "standard",
    • "delivery_point_barcode": "941071702108",
    • "address_type": "commercial",
    • "record_type": "street",
    • "default_building_address": false,
    • "county": "SAN FRANCISCO",
    • "county_fips": "06075",
    • "carrier_route": "C032",
    • "carrier_route_type": "city_delivery",
    • "po_box_only_flag": "N",
    • "latitude": 37.77597542841264,
    • "longitude": -122.3929557343685
    },
  • "deliverability_analysis": {
    • "dpv_confirmation": "Y",
    • "dpv_cmra": "N",
    • "dpv_vacant": "N",
    • "dpv_active": "Y",
    • "dpv_inactive_reason": "",
    • "dpv_throwback": "N",
    • "dpv_non_delivery_day_flag": "N",
    • "dpv_non_delivery_day_values": "",
    • "dpv_no_secure_location": "N",
    • "dpv_door_not_accessible": "N",
    • "dpv_footnotes": [
      ],
    • "ews_match": false,
    • "lacs_indicator": "",
    • "lacs_return_code": "",
    • "suite_return_code": ""
    },
  • "lob_confidence_score": {
    • "score": 100,
    • "level": "high"
    },
  • "object": "us_verification"
}

US Verification Types

These are detailed definitions for various fields in the US verification object.

ZIP Code Types - components[zip_code_type]

@@ -5830,7 +5829,7 @@

DPV Footnotes - deliverability_analysis[dpv_footnotes]

object
string
Default: "us_autocompletion"
Value: "us_autocompletion"

Value is resource type.

Request samples

Content type
Example
{
  • "address_prefix": "185 B",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107",
  • "geo_ip_sort": false
}

Response samples

Content type
application/json
Example
{
  • "id": "us_auto_a3ac97bcfbb2460ab20c",
  • "suggestions": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "object": "us_autocompletion"
}

Reverse Geocode Lookups

Find a list of zip codes associated with a valid US location via latitude and longitude.

back to top

+
https://api.lob.com/v1/us_autocompletions

Request samples

Content type
Example
{
  • "address_prefix": "185 B",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107",
  • "geo_ip_sort": false
}

Response samples

Content type
application/json
Example
{
  • "id": "us_auto_a3ac97bcfbb2460ab20c",
  • "suggestions": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "object": "us_autocompletion"
}

Reverse Geocode Lookups

Find a list of zip codes associated with a valid US location via latitude and longitude.

back to top

Reverse Geocode Lookup

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

Authorizations:
basicAuth
query Parameters
size
integer [ 1 .. 50 ]
Default: 5
Example: size=5

Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.

Request Body schema:
latitude
required
number or null <float> [ -90 .. 90 ]

A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with longitude to pinpoint locations on a map.

@@ -5844,7 +5843,7 @@

DPV Footnotes - deliverability_analysis[dpv_footnotes]

object
string
Default: "us_reverse_geocode_lookup"
Value: "us_reverse_geocode_lookup"

Value is resource type.

Request samples

Content type
{
  • "latitude": 37.7749,
  • "longitude": 122.4194
}

Response samples

Content type
application/json
{
  • "id": "us_reverse_geocode_8a013f3e",
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Zip Lookups

Find a list of cities, states and associated information about a US ZIP code.

back to top

+
https://api.lob.com/v1/us_reverse_geocode_lookups

Request samples

Content type
{
  • "latitude": 37.7749,
  • "longitude": 122.4194
}

Response samples

Content type
application/json
{
  • "id": "us_reverse_geocode_8a013f3e",
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Zip Lookups

Find a list of cities, states and associated information about a US ZIP code.

back to top

Lookups

Returns information about a ZIP code

Authorizations:
basicAuth
Request Body schema:
zip_code
required
string^\d{5}$

A 5-digit ZIP code.

Responses

object
required
string
Default: "us_zip_lookup"
Value: "us_zip_lookup"

Value is resource type.

Request samples

Content type
{
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "us_zip_c7cb63d68f8d6",
  • "cities": [
    • {
      }
    ],
  • "zip_code_type": "standard",
  • "object": "us_zip_lookup",
  • "zip_code": "94107"
}

Identity Validation

Validates whether a given name is associated with an address.

+
https://api.lob.com/v1/us_zip_lookups

Request samples

Content type
{
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "us_zip_c7cb63d68f8d6",
  • "cities": [
    • {
      }
    ],
  • "zip_code_type": "standard",
  • "object": "us_zip_lookup",
  • "zip_code": "94107"
}

Identity Validation

Validates whether a given name is associated with an address.

back to top

Identity Validation

Validates whether a given name is associated with an address.

Authorizations:
basicAuth
Request Body schema:
One of
Any of
city
required
string <= 200 characters

The name of the city. city and state are required if no zip_code is passed.

@@ -5920,7 +5919,7 @@

DPV Footnotes - deliverability_analysis[dpv_footnotes]

object
string
Default: "id_validation"
Value: "id_validation"

Value is resource type.

Request samples

Content type
{
  • "recipient": "Larry Lobster",
  • "primary_line": "210 King St.",
  • "secondary_line": "",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "id_validation_8a013f3e",
  • "recipient": "LARRY LOBSTER",
  • "primary_line": "210 KING ST.",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1728",
  • "score": 100,
  • "confidence": "high",
  • "object": "id_validation"
}

Intl Verifications

Address verification for non-US addresses +

https://api.lob.com/v1/identity_validation

Request samples

Content type
{
  • "recipient": "Larry Lobster",
  • "primary_line": "210 King St.",
  • "secondary_line": "",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "id_validation_8a013f3e",
  • "recipient": "LARRY LOBSTER",
  • "primary_line": "210 KING ST.",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1728",
  • "score": 100,
  • "confidence": "high",
  • "object": "id_validation"
}

Intl Verifications

Address verification for non-US addresses

back to top
@@ -5966,7 +5965,7 @@

DPV Footnotes - deliverability_analysis[dpv_footnotes]

Response Schema: application/json
required
Array of intl_verification (object) or error (object)
errors
required
boolean

Indicates whether any errors occurred during the verification process.

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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.

+
https://api.lob.com/v1/bulk/intl_verifications

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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.

Authorizations:
basicAuth
header Parameters
x-lang-output
string
Enum: "native" "match"
  • native - Translate response to the native language of the country in the request
  • match - match the response to the language in the request
    • @@ -6031,7 +6030,7 @@

    DPV Footnotes - deliverability_analysis[dpv_footnotes]

object
string
Default: "intl_verification"
Value: "intl_verification"

Value is resource type.

Request samples

Content type
Example
{
  • "recipient": "Harry Zhang",
  • "primary_line": "370 Water St",
  • "secondary_line": "",
  • "city": "Summerside",
  • "state": "Prince Edward Island",
  • "postal code": "C1N 1C4",
  • "country": "CA"
}

Response samples

Content type
application/json
Example
{
  • "id": "intl_ver_c7cb63d68f8d6",
  • "recipient": null,
  • "primary_line": "370 WATER ST",
  • "secondary_line": "",
  • "last_line": "SUMMERSIDE PE C1N 1C4",
  • "country": "CA",
  • "coverage": "SUBBUILDING",
  • "deliverability": "deliverable",
  • "status": "LV4",
  • "components": {
    • "primary_number": "370",
    • "street_name": "WATER ST",
    • "city": "SUMMERSIDE",
    • "state": "PE",
    • "postal_code": "C1N 1C4"
    },
  • "object": "intl_verification"
}

Webhooks

Webhooks are an easy way to get notifications on events happening asynchronously +

https://api.lob.com/v1/intl_verifications

Request samples

Content type
Example
{
  • "recipient": "Harry Zhang",
  • "primary_line": "370 Water St",
  • "secondary_line": "",
  • "city": "Summerside",
  • "state": "Prince Edward Island",
  • "postal code": "C1N 1C4",
  • "country": "CA"
}

Response samples

Content type
application/json
Example
{
  • "id": "intl_ver_c7cb63d68f8d6",
  • "recipient": null,
  • "primary_line": "370 WATER ST",
  • "secondary_line": "",
  • "last_line": "SUMMERSIDE PE C1N 1C4",
  • "country": "CA",
  • "coverage": "SUBBUILDING",
  • "deliverability": "deliverable",
  • "status": "LV4",
  • "components": {
    • "primary_number": "370",
    • "street_name": "WATER ST",
    • "city": "SUMMERSIDE",
    • "state": "PE",
    • "postal_code": "C1N 1C4"
    },
  • "object": "intl_verification"
}

Webhooks

Webhooks are an easy way to get notifications on events happening asynchronously within Lob's architecture. For example, when a postcard gets a "Processed For Delivery" tracking event, an event object of type postcard.processed_for_delivery will be created. If you are subscribed to that event type in that Environment @@ -6507,7 +6506,7 @@

Bank Accounts

reference_id
required
string

Unique identifier of the related resource for the event.

required
object (event_type)
date_created
required
string <date-time> (date_created)

A timestamp in ISO 8601 format of the date the resource was created.

object
required
string
Default: "event"
Value: "event"

Value is resource type.

-

Response samples

Content type
application/json
{}

Tracking Events

As mailpieces travel through the mail stream, USPS scans their unique barcodes, and Lob processes these mail scans to generate tracking events.

+

Response samples

Content type
application/json
{}

Tracking Events

As mailpieces travel through the mail stream, USPS scans their unique barcodes, and Lob processes these mail scans to generate tracking events.

Certified Tracking Event Details

Letters sent with USPS Certified Mail are fully tracked by USPS, and @@ -6732,7 +6731,7 @@

Certified Tracking Event Details

time
string <date-time>

A timestamp in ISO 8601 format of the date USPS registered the event.

details
object or null
Value: null

Will be null for type=normal events

location
string or null

The zip code in which the scan event occurred. Null for Mailed events.

-

Response samples

Content type
application/json
Example
{
  • "id": "evnt_9e84094c9368cfb",
  • "type": "normal",
  • "name": "In Local Area",
  • "details": null,
  • "location": "72231",
  • "time": "2016-06-30T15:51:41.000Z",
  • "date_created": "2016-06-30T17:41:59.771Z",
  • "date_modified": "2016-06-30T17:41:59.771Z",
  • "object": "tracking_event"
}

Billing Groups

The Billing Groups API allows you to create and view labels that can be attached to certain consumption-based +

Response samples

Content type
application/json
Example
{
  • "id": "evnt_9e84094c9368cfb",
  • "type": "normal",
  • "name": "In Local Area",
  • "details": null,
  • "location": "72231",
  • "time": "2016-06-30T15:51:41.000Z",
  • "date_created": "2016-06-30T17:41:59.771Z",
  • "date_modified": "2016-06-30T17:41:59.771Z",
  • "object": "tracking_event"
}

Billing Groups

The Billing Groups API allows you to create and view labels that can be attached to certain consumption-based usages of Letters, Checks, Postcards and Self-Mailers to customize your bill. Please check each resource API section to learn more about how to access the Billing Groups API.

back to top
@@ -6747,9 +6746,9 @@

Certified Tracking Event Details

object
string
Default: "billing_group"
Value: "billing_group"

Value is resource type.

Request samples 

curl https://api.lob.com/v1/billing_groups/bg_4bb02b527a72667d0 \
+
https://api.lob.com/v1/billing_groups/{bg_id}

Request samples 

curl https://api.lob.com/v1/billing_groups/bg_4bb02b527a72667d0 \
 -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

Update

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

+

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

Update

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

Authorizations:
basicAuth
path Parameters
bg_id
required
string (bg_id) ^bg_[a-zA-Z0-9]+$

id of the billing_group

Request Body schema:
description
string (bg_description) <= 255 characters

Description of the billing group.

name
string (name) <= 255 characters

Name of the billing group.

@@ -6765,7 +6764,7 @@

Certified Tracking Event Details

object
string
Default: "billing_group"
Value: "billing_group"

Value is resource type.

Request samples

Content type
{
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends"
}

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

List

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.

+
https://api.lob.com/v1/billing_groups/{bg_id}

Request samples

Content type
{
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends"
}

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

List

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.

Authorizations:
basicAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=10

How many results to return.

offset
integer
Default: 0

An integer that designates the offset at which to begin returning results. Defaults to 0.

include
Array of strings

Request that the response include the total count by specifying include=["total_count"].

@@ -6781,9 +6780,9 @@

Certified Tracking Event Details

Array of objects (billing_group)

list of billing_groups

Request samples 

curl -X GET "https://api.lob.com/v1/billing_groups?limit=2" \
+
https://api.lob.com/v1/billing_groups

Request samples 

curl -X GET "https://api.lob.com/v1/billing_groups?limit=2" \
 -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "prev_url": null,
  • "count": 2
}

Create

Creates a new billing_group with the provided properties.

+

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "prev_url": null,
  • "count": 2
}

Create

Creates a new billing_group with the provided properties.

Authorizations:
basicAuth
Request Body schema:
name
required
string (name) <= 255 characters

Name of the billing group.

description
string (bg_description) <= 255 characters

Description of the billing group.

Responses

object
string
Default: "billing_group"
Value: "billing_group"

Value is resource type.

Request samples

Content type
{
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends"
}

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

Buckslips

The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters. +

https://api.lob.com/v1/billing_groups

Request samples

Content type
{
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends"
}

Response samples

Content type
application/json
{
  • "id": "bg_c94e83ca2cd5121",
  • "name": "Marketing Dept",
  • "description": "Usage group used for the Marketing Dept resource sends",
  • "date_created": "2017-11-07T22:56:10.962Z",
  • "date_modified": "2017-11-07T22:56:10.962Z",
  • "object": "billing_group"
}

Buckslips

The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters. The API provides endpoints for creating buckslips, retrieving individual buckslips, creating buckslip orders, and retrieving a list of buckslips.

back to top

List

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

@@ -6814,9 +6813,9 @@

Certified Tracking Event Details

Array of objects (buckslip)

list of buckslips

Request samples 

curl -X GET "https://api.lob.com/v1/buckslips?limit=2" \
+
https://api.lob.com/v1/buckslips

Request samples 

curl -X GET "https://api.lob.com/v1/buckslips?limit=2" \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{}

Create

Creates a new buckslip given information

+

Response samples

Content type
application/json
{}

Create

Creates a new buckslip given information

Authorizations:
basicAuth
Request Body schema:
required
remote_file_url (string) or local_file_path (string)

A PDF template for the front of the buckslip

description
string or null (buckslip_description) <= 255 characters

Description of the buckslip.

size
string
Default: "8.75x3.75"
Value: "8.75x3.75"

The size of the buckslip

@@ -6844,7 +6843,7 @@

Certified Tracking Event Details

size
string
Default: "8.75x3.75"
Value: "8.75x3.75"

The size of the buckslip

Request samples

Content type
{}

Response samples

Content type
application/json
{}

Retrieve

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

+
https://api.lob.com/v1/buckslips

Request samples

Content type
{}

Response samples

Content type
application/json
{}

Retrieve

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

Authorizations:
basicAuth
path Parameters
buckslip_id
required
string (buckslip_id) ^bck_[a-zA-Z0-9]+$

id of the buckslip

Responses

Response Schema: application/json
date_created
required
string <date-time> (date_created)

A timestamp in ISO 8601 format of the date the resource was created.

@@ -6869,9 +6868,9 @@

Certified Tracking Event Details

size
string
Default: "8.75x3.75"
Value: "8.75x3.75"

The size of the buckslip

Request samples 

curl https://api.lob.com/v1/buckslips/bck_7a6d73c5c8457fc \
+
https://api.lob.com/v1/buckslips/{buckslip_id}

Request samples 

curl https://api.lob.com/v1/buckslips/bck_7a6d73c5c8457fc \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{}

Update

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

+

Response samples

Content type
application/json
{}

Update

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

Authorizations:
basicAuth
path Parameters
buckslip_id
required
string (buckslip_id) ^bck_[a-zA-Z0-9]+$

id of the buckslip

Request Body schema:
description
string or null (buckslip_description) <= 255 characters

Description of the buckslip.

auto_reorder
boolean

Allows for auto reordering

@@ -6899,16 +6898,16 @@

Certified Tracking Event Details

size
string
Default: "8.75x3.75"
Value: "8.75x3.75"

The size of the buckslip

Request samples

Content type
{
  • "description": "Test buckslip",
  • "auto_reorder": true
}

Response samples

Content type
application/json
{}

Delete

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

+
https://api.lob.com/v1/buckslips/{buckslip_id}

Request samples

Content type
{
  • "description": "Test buckslip",
  • "auto_reorder": true
}

Response samples

Content type
application/json
{}

Delete

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

Authorizations:
basicAuth
path Parameters
buckslip_id
required
string (buckslip_id) ^bck_[a-zA-Z0-9]+$

id of the buckslip

Responses

Response Schema: application/json
id
string (buckslip_id) ^bck_[a-zA-Z0-9]+$

Unique identifier prefixed with bck_.

deleted
boolean (deleted)

Only returned if the resource has been successfully deleted.

Request samples 

curl -X DELETE https://api.lob.com/v1/buckslips/bck_7a6d73c5c8457fc \
+
https://api.lob.com/v1/buckslips/{buckslip_id}

Request samples 

curl -X DELETE https://api.lob.com/v1/buckslips/bck_7a6d73c5c8457fc \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "buckslip_123456789",
  • "deleted": true
}

Buckslip Orders

The Buckslip Orders endpoint allows you to easily create buckslip orders for existing buckslips. +

Response samples

Content type
application/json
{
  • "id": "buckslip_123456789",
  • "deleted": true
}

Buckslip Orders

The Buckslip Orders endpoint allows you to easily create buckslip orders for existing buckslips. The API provides endpoints for creating buckslip orders and listing buckslip orders for a given buckslip.

back to top

Retrieve

Retrieves the buckslip orders associated with the given buckslip id.

@@ -6924,9 +6923,9 @@

Certified Tracking Event Details

Array of objects (buckslip_order)

List of buckslip orders

Request samples 

curl https://api.lob.com/v1/buckslips/bck_6afffd19045076c/orders/ \
+
https://api.lob.com/v1/buckslips/{buckslip_id}/orders

Request samples 

curl https://api.lob.com/v1/buckslips/bck_6afffd19045076c/orders/ \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 1
}

Create

Creates a new buckslip order given information

+

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 1
}

Create

Creates a new buckslip order given information

Authorizations:
basicAuth
path Parameters
buckslip_id
required
string (buckslip_id) ^bck_[a-zA-Z0-9]+$

The ID of the buckslip to which the buckslip orders belong.

Request Body schema:
quantity
required
integer [ 5000 .. 10000000 ]

The quantity of buckslips in the order (minimum 5,000).

Responses

expected_availability_date
string <date-time>

The fixed deadline for the buckslips to be printed.

Request samples

Content type
{
  • "quantity": 10000
}

Response samples

Content type
application/json
{
  • "id": "bo_e0f8a0562a06bea7f",
  • "buckslip_id": "bck_6afffd19045076c",
  • "status": "available",
  • "quantity_ordered": 10000,
  • "unit_price": 0.75,
  • "cancelled_reason": "No longer needed",
  • "availability_date": "2021-10-12T21:41:48.326Z",
  • "expected_availability_date": "2021-11-04T21:03:18.871Z",
  • "date_created": "2021-10-07T21:03:18.871Z",
  • "date_modified": "2021-10-16T01:00:30.144Z",
  • "object": "buckslip_order"
}

Cards

The cards endpoint allows you to easily create cards that can later be affixed to Letters. +

https://api.lob.com/v1/buckslips/{buckslip_id}/orders

Request samples

Content type
{
  • "quantity": 10000
}

Response samples

Content type
application/json
{
  • "id": "bo_e0f8a0562a06bea7f",
  • "buckslip_id": "bck_6afffd19045076c",
  • "status": "available",
  • "quantity_ordered": 10000,
  • "unit_price": 0.75,
  • "cancelled_reason": "No longer needed",
  • "availability_date": "2021-10-12T21:41:48.326Z",
  • "expected_availability_date": "2021-11-04T21:03:18.871Z",
  • "date_created": "2021-10-07T21:03:18.871Z",
  • "date_modified": "2021-10-16T01:00:30.144Z",
  • "object": "buckslip_order"
}

Cards

The cards endpoint allows you to easily create cards that can later be affixed to Letters. The API provides endpoints for creating cards, retrieving individual cards, creating card orders, and retrieving a list of cards.

back to top

List

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

@@ -6961,9 +6960,9 @@

Certified Tracking Event Details

Array of objects (card)

list of cards

Request samples 

curl -X GET "https://api.lob.com/v1/cards?limit=2" \
+
https://api.lob.com/v1/cards

Request samples 

curl -X GET "https://api.lob.com/v1/cards?limit=2" \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{}

Create

Creates a new card given information

+

Response samples

Content type
application/json
{}

Create

Creates a new card given information

Authorizations:
basicAuth
Request Body schema:
required
remote_file_url (string) or local_file_path (string)

A PDF template for the front of the card

description
string or null (card_description) <= 255 characters

Description of the card.

size
string
Default: "2.125x3.375"
Enum: "3.375x2.125" "2.125x3.375"

The size of the card

@@ -6988,7 +6987,7 @@

Certified Tracking Event Details

size
string
Default: "2.125x3.375"
Enum: "3.375x2.125" "2.125x3.375"

The size of the card

Request samples

Content type
{}

Response samples

Content type
application/json
{}

Retrieve

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

+
https://api.lob.com/v1/cards

Request samples

Content type
{}

Response samples

Content type
application/json
{}

Retrieve

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

Authorizations:
basicAuth
path Parameters
card_id
required
string (card_id) ^card_[a-zA-Z0-9]+$

id of the card

Responses

Response Schema: application/json
date_created
required
string <date-time> (date_created)

A timestamp in ISO 8601 format of the date the resource was created.

@@ -7010,9 +7009,9 @@

Certified Tracking Event Details

size
string
Default: "2.125x3.375"
Enum: "3.375x2.125" "2.125x3.375"

The size of the card

Request samples 

curl https://api.lob.com/v1/cards/card_7a6d73c5c8457fc \
+
https://api.lob.com/v1/cards/{card_id}

Request samples 

curl https://api.lob.com/v1/cards/card_7a6d73c5c8457fc \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{}

Update

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

+

Response samples

Content type
application/json
{}

Update

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

Authorizations:
basicAuth
path Parameters
card_id
required
string (card_id) ^card_[a-zA-Z0-9]+$

id of the card

Request Body schema:
description
string or null (card_description) <= 255 characters

Description of the card.

auto_reorder
boolean

Allows for auto reordering

@@ -7037,16 +7036,16 @@

Certified Tracking Event Details

size
string
Default: "2.125x3.375"
Enum: "3.375x2.125" "2.125x3.375"

The size of the card

Request samples

Content type
{
  • "description": "Test card",
  • "auto_reorder": true
}

Response samples

Content type
application/json
{}

Delete

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

+
https://api.lob.com/v1/cards/{card_id}

Request samples

Content type
{
  • "description": "Test card",
  • "auto_reorder": true
}

Response samples

Content type
application/json
{}

Delete

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

Authorizations:
basicAuth
path Parameters
card_id
required
string (card_id) ^card_[a-zA-Z0-9]+$

id of the card

Responses

Response Schema: application/json
id
string (card_id) ^card_[a-zA-Z0-9]+$

Unique identifier prefixed with card_.

deleted
boolean (deleted)

Only returned if the resource has been successfully deleted.

Request samples 

curl -X DELETE https://api.lob.com/v1/cards/card_7a6d73c5c8457fc \
+
https://api.lob.com/v1/cards/{card_id}

Request samples 

curl -X DELETE https://api.lob.com/v1/cards/card_7a6d73c5c8457fc \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "id": "card_123456789",
  • "deleted": true
}

Card Orders

The card orders endpoint allows you to easily create card orders for existing cards. +

Response samples

Content type
application/json
{
  • "id": "card_123456789",
  • "deleted": true
}

Card Orders

The card orders endpoint allows you to easily create card orders for existing cards. The API provides endpoints for creating card orders and listing card orders for a given card.

back to top

Retrieve

Retrieves the card orders associated with the given card id.

@@ -7062,9 +7061,9 @@

Certified Tracking Event Details

Array of objects (card_order)

List of card orders

Request samples 

curl https://api.lob.com/v1/cards/card_6afffd19045076c/orders/ \
+
https://api.lob.com/v1/cards/{card_id}/orders

Request samples 

curl https://api.lob.com/v1/cards/card_6afffd19045076c/orders/ \
   -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 1
}

Create

Creates a new card order given information

+

Response samples

Content type
application/json
{
  • "data": [
    • {
      }
    ],
  • "object": "list",
  • "next_url": null,
  • "previous_url": null,
  • "count": 1
}

Create

Creates a new card order given information

Authorizations:
basicAuth
path Parameters
card_id
required
string (card_id) ^card_[a-zA-Z0-9]+$

The ID of the card to which the card orders belong.

Request Body schema:
quantity
required
integer [ 10000 .. 10000000 ]

The quantity of cards in the order (minimum 10,000).

Responses

expected_availability_date
string <date-time>

The fixed deadline for the cards to be printed.

Request samples

Content type
{
  • "quantity": 10000
}

Response samples

Content type
application/json
{
  • "id": "co_e0f8a0562a06bea7f",
  • "card_id": "card_6afffd19045076c",
  • "status": "available",
  • "inventory": 9500,
  • "quantity_ordered": 10000,
  • "unit_price": 0.75,
  • "cancelled_reason": "No longer needed",
  • "availability_date": "2021-10-12T21:41:48.326Z",
  • "expected_availability_date": "2021-11-04T21:03:18.871Z",
  • "date_created": "2021-10-07T21:03:18.871Z",
  • "date_modified": "2021-10-16T01:00:30.144Z",
  • "object": "card_order"
}

QR Codes

Lob QR codes allow you to generate a QR code that is unique to each mailpiece, thereby allowing each and every customers to receive a personalized link. See the Create endpoint for Letters, Postcards or Self Mailers to learn how to embed a QR code into your mail piece.

+
https://api.lob.com/v1/cards/{card_id}/orders

Request samples

Content type
{
  • "quantity": 10000
}

Response samples

Content type
application/json
{
  • "id": "co_e0f8a0562a06bea7f",
  • "card_id": "card_6afffd19045076c",
  • "status": "available",
  • "inventory": 9500,
  • "quantity_ordered": 10000,
  • "unit_price": 0.75,
  • "cancelled_reason": "No longer needed",
  • "availability_date": "2021-10-12T21:41:48.326Z",
  • "expected_availability_date": "2021-11-04T21:03:18.871Z",
  • "date_created": "2021-10-07T21:03:18.871Z",
  • "date_modified": "2021-10-16T01:00:30.144Z",
  • "object": "card_order"
}

QR Codes

Lob QR codes allow you to generate a QR code that is unique to each mailpiece, thereby allowing each and every customers to receive a personalized link. See the Create endpoint for Letters, Postcards or Self Mailers to learn how to embed a QR code into your mail piece.

Webhooks can be used to integrate Lob QR code scans into your omni channel marketing strategy. See the Webhooks section of our documentation to learn how to enable the letter.viewed, postcard.viewed and self_mailer.viewed event notifications for your mail pieces.

Furthermore, our QR code Analytics endpoint can be used to track the impact and engagement rate of your mail sends. Lob can tell you exactly which recipients opened your mailpiece. Our Analytics endpoint allows you to see exactly which recipient scanned a mailpiece, when they scanned it, and more!

back to top
@@ -7101,9 +7100,9 @@

Certified Tracking Event Details

scanned_count
integer

Indicates the number of QR Codes out of count that were scanned atleast once.

Array of objects (qr_code_scans)

List of QR code analytics

Request samples 

curl -X GET "https://api.lob.com/v1/qr_code_analytics?limit=2&scanned=true" \
+
https://api.lob.com/v1/qr_code_analytics

Request samples 

curl -X GET "https://api.lob.com/v1/qr_code_analytics?limit=2&scanned=true" \
 -u <YOUR API KEY>:
-

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "count": 2,
  • "scanned_count": 2,
  • "total_count": 2
}

URL Shortener

Lob's URL shortener allows you to generate unique short links, either with Lob's own domain or your own custom domains. Each custom link enables Lob to track mail individually and provide customers the relevant tracking data in their dashboard.

+

Response samples

Content type
application/json
{
  • "data": [
    • {
      },
    • {
      }
    ],
  • "object": "list",
  • "count": 2,
  • "scanned_count": 2,
  • "total_count": 2
}

URL Shortener

Lob's URL shortener allows you to generate unique short links, either with Lob's own domain or your own custom domains. Each custom link enables Lob to track mail individually and provide customers the relevant tracking data in their dashboard.

Webhooks can be used to integrate Lob's URL Shortener scans into your omni channel marketing stratergy. See the Webhooks section of our documentation to learn how to enable the letter.viewed, postcard.viewed and self_mailer.viewed event notifications for your mail pieces.

Furthermore, you can use our Retrieve endpoints to track the impact and engagement rate of links created.

back to top
@@ -7118,16 +7117,16 @@

Certified Tracking Event Details

updated_at
string

The date and time the domain was last updated.

Request samples 

curl -X GET "https://api.lob.com/v1/domains/{domain_id}" \
+
https://api.lob.com/v1/domains/{domain_id}

Request samples 

curl -X GET "https://api.lob.com/v1/domains/{domain_id}" \
   -u <YOUR_LIVE_API_KEY>:
-

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "error_redirect_link": "string",
  • "status": "configured",
  • "created_at": "string",
  • "updated_at": "string"
}

Delete a Domain

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

+

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "error_redirect_link": "string",
  • "status": "configured",
  • "created_at": "string",
  • "updated_at": "string"
}

Delete a Domain

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

Authorizations:
basicAuth
path Parameters
domain_id
required
string

Unique identifier for a domain.

Responses

Response Schema: application/json
id
string

Unique identifier for a domain.

deleted
boolean

Only returned if the domain was successfully deleted.

Response samples

Content type
application/json
{
  • "id": "string",
  • "deleted": true
}

Create Domain

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

+
https://api.lob.com/v1/domains/{domain_id}

Response samples

Content type
application/json
{
  • "id": "string",
  • "deleted": true
}

Create Domain

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

Authorizations:
basicAuth
Request Body schema:
domain
required
string (domain)

The registered domain/hostname.

error_redirect_link
string (error_redirect_link)

URL to redirect customers if a short link is broken or inactive.

Responses

updated_at
string

The date and time the domain was last updated.

Request samples

Content type
Example
{
  • "domain": "lob.st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "error_redirect_link": "string",
  • "status": "configured",
  • "created_at": "string",
  • "updated_at": "string"
}

List all domains

Retrieve a list of all created domains.

+
https://api.lob.com/v1/domains

Request samples

Content type
Example
{
  • "domain": "lob.st"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "error_redirect_link": "string",
  • "status": "configured",
  • "created_at": "string",
  • "updated_at": "string"
}

List all domains

Retrieve a list of all created domains.

Authorizations:
basicAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10
Example: limit=10

How many results to return.

object or object

before and after are both optional but only one of them can be in the query at a time.

status
string
Enum: "configured" "not_configured"

Filter domains by their configuration status.

@@ -7152,9 +7151,9 @@

Certified Tracking Event Details

Array of objects (domain_response)

List of domains.

Request samples 

curl -X GET "https://api.lob.com/v1/domains?limit=2" \
+
https://api.lob.com/v1/domains

Request samples 

curl -X GET "https://api.lob.com/v1/domains?limit=2" \
   -u <YOUR_LIVE_API_KEY>:
-

Response samples

Content type
application/json
{
  • "object": "string",
  • "next_url": "string",
  • "previous_url": "string",
  • "count": 0,
  • "total_count": 0,
  • "data": [
    • {
      }
    ]
}

Request samples

Content type
Example
{
  • "resource_id": "ltr_133"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "domain_id": "string",
  • "redirect_link": "string",
  • "short_link": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    },
  • "created_at": "string",
  • "updated_at": "string"
}

Request samples

Content type
Example
{}

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "domain_id": "string",
  • "redirect_link": "string",
  • "short_link": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    },
  • "created_at": "string",
  • "updated_at": "string"
}

Request samples 

curl -X GET "https://api.lob.com/v1/links?limit=2" \
+
https://api.lob.com/v1/links

Request samples 

curl -X GET "https://api.lob.com/v1/links?limit=2" \
   -u <YOUR_LIVE_API_KEY>:
-

Response samples

Content type
application/json
{
  • "object": "string",
  • "next_url": "string",
  • "previous_url": "string",
  • "count": 0,
  • "total_count": 0,
  • "data": [
    • {
      }
    ]
}

Beta Program

At Lob, we pride ourselves on building high quality platform capabilities rapidly +

Response samples

Content type
application/json
{
  • "object": "string",
  • "next_url": "string",
  • "previous_url": "string",
  • "count": 0,
  • "total_count": 0,
  • "data": [
    • {
      }
    ]
}

Beta Program

At Lob, we pride ourselves on building high quality platform capabilities rapidly and iteratively, so we can constantly be delivering additional value to our customers. When evaluating a new product or feature from Lob, you may see that it has been released in Beta.

Typically, something in Beta means that the feature is early in its lifecycle here at @@ -7808,7 +7807,7 @@

Changelog

View our Changelog here.