From 11447ace7f9ca4fec439e75d6045113128f93bdd Mon Sep 17 00:00:00 2001 From: sudoku-lord Date: Mon, 8 Aug 2022 11:13:57 -0700 Subject: [PATCH 1/5] added separate campaign model to avoid recursion and clean up creative file --- dist/lob-api-bundled.yml | 123 +-- dist/lob-api-postman.json | 822 ++++++++++++------- docs/index.html | 8 +- resources/creatives/models/campaign_item.yml | 43 + resources/creatives/models/campaign_list.yml | 26 + resources/creatives/models/creative.yml | 75 +- 6 files changed, 667 insertions(+), 430 deletions(-) create mode 100644 resources/creatives/models/campaign_item.yml create mode 100644 resources/creatives/models/campaign_list.yml diff --git a/dist/lob-api-bundled.yml b/dist/lob-api-bundled.yml index 497373c1..ac5d9146 100644 --- a/dist/lob-api-bundled.yml +++ b/dist/lob-api-bundled.yml @@ -7011,6 +7011,67 @@ components: description: Unique identifier prefixed with `crv_`. pattern: ^crv_[a-zA-Z0-9]+$ example: crv_2a3b096c409b32c + campaign_item: + allOf: + - $ref: '#/components/schemas/lob_base' + - $ref: '#/components/schemas/campaign_writable' + - type: object + required: + - id + - account_id + - name + - description + - schedule_type + - use_type + - is_draft + - creatives + - auto_cancel_if_ncoa + - date_created + - date_modified + - object + properties: + id: + $ref: '#/components/schemas/cmp_id' + account_id: + description: Account ID that this campaign is associated with. + type: string + is_draft: + description: Whether or not the campaign is still a draft. + type: boolean + default: true + creatives: + description: >- + An array of creatives that have been associated with this + campaign. + type: array + object: + type: string + description: Value is resource type. + enum: + - campaign + default: campaign + campaign_list: + type: array + description: Array of campaigns associated with the creative ID + items: + $ref: '#/components/schemas/campaign_item' + example: + - id: cmp_ed76e33e7ac4d0bd + name: My postman Campaign 2 + description: Created via postman again + schedule_type: immediate + send_date: null + target_delivery_date: null + cancel_window_campaign_minutes: null + metadata: {} + use_type: null + is_draft: true + deleted: false + creatives: [] + auto_cancel_if_ncoa: false + date_created: '2022-07-26T20:20:25.016Z' + date_modified: '2022-07-26T20:20:25.016Z' + object: campaign creative: allOf: - $ref: '#/components/schemas/lob_base' @@ -7055,67 +7116,7 @@ components: template(s) as artwork asset(s). An empty array will be returned if no `template_preview`s have been generated for the creative. campaigns: - title: Campaigns - type: array - description: Array of campaigns associated with the creative ID - items: - allOf: - - $ref: '#/components/schemas/campaign_writable' - - type: object - required: - - id - - name - - description - - schedule_type - - is_draft - - auto_cancel_if_ncoa - - date_created - - date_modified - - object - properties: - id: - $ref: '#/components/schemas/cmp_id' - account_id: - description: Account ID that this campaign is associated with. - type: string - is_draft: - description: Whether or not the campaign is still a draft. - type: boolean - default: true - creatives: - description: >- - An array of creatives that have been associated with - this campaign. - type: array - date_created: - $ref: '#/components/schemas/date_created' - date_modified: - $ref: '#/components/schemas/date_modified' - deleted: - $ref: '#/components/schemas/deleted' - object: - allOf: - - $ref: '#/components/schemas/object' - - enum: - - campaign - default: campaign - example: - - id: cmp_ed76e33e7ac4d0bd - name: My postman Campaign 2 - description: Created via postman again - schedule_type: immediate - send_date: null - target_delivery_date: null - cancel_window_campaign_minutes: null - metadata: {} - use_type: null - is_draft: true - deleted: false - creatives: [] - auto_cancel_if_ncoa: false - date_created: '2022-07-26T20:20:25.016Z' - date_modified: '2022-07-26T20:20:25.016Z' - object: campaign + $ref: '#/components/schemas/campaign_list' object: type: string description: Value is resource type. diff --git a/dist/lob-api-postman.json b/dist/lob-api-postman.json index 70ce6299..fc92f695 100644 --- a/dist/lob-api-postman.json +++ b/dist/lob-api-postman.json @@ -1,7 +1,7 @@ { "item": [ { - "id": "bb516bf1-d212-4664-ae18-6f424fa8d64c", + "id": "7d945f69-2e95-4ac1-abd1-7a757431f010", "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": "038cf2e0-dba8-48ae-bdf2-20846ec6aee0", + "id": "d82225e3-0d00-4ea4-b818-45d16d491c0b", "name": "List", "request": { "name": "List", @@ -57,7 +57,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." } @@ -75,7 +75,7 @@ }, "response": [ { - "id": "db1a27fe-1821-4ae3-8dd2-8f0e2a3d59ed", + "id": "f7c354ee-518a-4af2-b0e2-b7b553e2f001", "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,7 +107,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -139,7 +151,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0d92c589-7ba5-4c1d-9670-0f352e776c6e", + "id": "a2900f61-72c2-4e36-b26e-e7569670e4dc", "name": "Error", "originalRequest": { "url": { @@ -171,7 +183,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -206,7 +230,7 @@ "event": [] }, { - "id": "b63beaea-4419-43b1-abbc-6710860e07d4", + "id": "d5e003e4-bb0e-4b26-954a-5d4fc0dc177d", "name": "Create", "request": { "name": "Create", @@ -269,7 +293,7 @@ }, "response": [ { - "id": "5a296000-1a58-4247-928f-afd0546807b7", + "id": "d0ca108f-062f-409a-82bb-a5594c11f818", "name": "Echos the writable fields of a newly created address object.", "originalRequest": { "url": { @@ -385,7 +409,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5477bfde-4930-4b9b-8994-93ae1ef554ec", + "id": "915ba050-9f97-4cb3-ae70-2c2c0185d324", "name": "Error", "originalRequest": { "url": { @@ -489,7 +513,7 @@ } }, { - "id": "ee522292-8a07-42d9-a608-111acdd9d552", + "id": "40e00c53-0214-41c4-86ec-cd5564ef1b86", "name": "Retrieve", "request": { "name": "Retrieve", @@ -527,7 +551,7 @@ }, "response": [ { - "id": "a003a4de-0c26-4274-89b3-f9feec9ce1d5", + "id": "76135f72-ca6a-4982-8e27-fea1c7a4dbdd", "name": "Returns an address object if a valid identifier was provided.", "originalRequest": { "url": { @@ -575,7 +599,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ee9aefe7-ca36-4079-8678-108a378542e4", + "id": "f7c76d15-c69c-4fa3-a968-92baca3eb1ad", "name": "Error", "originalRequest": { "url": { @@ -626,7 +650,7 @@ "event": [] }, { - "id": "c2bfe955-9d11-49d5-85dc-bf406c06af29", + "id": "8fe79b2d-78d6-4bbd-a121-429753e77f0d", "name": "Delete", "request": { "name": "Delete", @@ -664,7 +688,7 @@ }, "response": [ { - "id": "7a526907-992a-4e31-ae95-8e64c6aa44cc", + "id": "ee085d06-8d84-4db8-8021-08e6e2abeee1", "name": "Deleted", "originalRequest": { "url": { @@ -712,7 +736,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7ae859c3-fa47-4e31-92f2-2d0450b85c89", + "id": "1ab036cc-57b8-40bd-937e-f29d9a07f04f", "name": "Error", "originalRequest": { "url": { @@ -766,7 +790,7 @@ "event": [] }, { - "id": "d38d20ba-e034-4b42-819e-bb183be70a28", + "id": "d7660304-bb24-4bbe-b578-af207347c8cd", "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. While we encourage you to use a secret key for maximum\n security, you can publish these keys to JavaScript code or in an Android or iPhone app\n without exposing print and mail 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", @@ -776,7 +800,7 @@ "event": [] }, { - "id": "89a0b611-3e29-427a-9c16-00cef0f8876a", + "id": "f6f32972-1170-4057-8f23-a92a12e06604", "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", @@ -784,7 +808,7 @@ }, "item": [ { - "id": "0a332a5a-cdf4-468f-b59e-c707e6245a76", + "id": "ab78103a-e63f-4b23-af5f-2eb672e9ddaa", "name": "Verify", "request": { "name": "Verify", @@ -844,7 +868,7 @@ }, "response": [ { - "id": "2f02cc48-1600-4d87-bfa3-7b76db5378e4", + "id": "da9b06b4-a03f-420d-b8d2-2168f35c2f8a", "name": "Returns a bank_account object", "originalRequest": { "url": { @@ -933,7 +957,7 @@ "_postman_previewlanguage": "json" }, { - "id": "70a7f6cb-0b0f-40eb-b05b-334ad25f6f0a", + "id": "e37e1859-14be-4a43-a1c7-be8ba9255b07", "name": "Error", "originalRequest": { "url": { @@ -1010,7 +1034,7 @@ } }, { - "id": "3e694286-0535-45a9-a277-10c7c1a37862", + "id": "19f9940b-6a83-4754-bf59-162f7d2a166f", "name": "Retrieve", "request": { "name": "Retrieve", @@ -1048,7 +1072,7 @@ }, "response": [ { - "id": "5cfad7c9-d344-46ee-8f91-525285ad04ac", + "id": "8b2dae44-0042-4a7b-854e-09b5e7fd79a6", "name": "Returns a bank account object", "originalRequest": { "url": { @@ -1096,7 +1120,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b1f4e260-8b62-409b-8e7b-5fc80528591f", + "id": "9dfaa7af-81ac-4600-b64e-6e2faf21038a", "name": "Error", "originalRequest": { "url": { @@ -1147,7 +1171,7 @@ "event": [] }, { - "id": "021932de-90ed-4280-8a90-fba627f3bc24", + "id": "a8305e8a-c748-40fa-ac2b-e749533e11c2", "name": "Delete", "request": { "name": "Delete", @@ -1185,7 +1209,7 @@ }, "response": [ { - "id": "9ab70651-5ac4-4818-9fc5-c36f0b0c28ab", + "id": "6db4d9f9-5a1a-4280-b562-e017db939777", "name": "Deleted", "originalRequest": { "url": { @@ -1233,7 +1257,7 @@ "_postman_previewlanguage": "json" }, { - "id": "172c47e2-1671-468d-b9e4-e466a1c58abb", + "id": "d1523f09-686f-4374-b80b-e12279c75873", "name": "Error", "originalRequest": { "url": { @@ -1284,7 +1308,7 @@ "event": [] }, { - "id": "49b0c939-789f-4e28-956d-e608e049f128", + "id": "9f365781-282d-47ab-8ca3-53624585e8a5", "name": "List", "request": { "name": "List", @@ -1332,7 +1356,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." } @@ -1350,7 +1374,7 @@ }, "response": [ { - "id": "0927d96a-4b29-4417-a67a-c3500ca6d9d9", + "id": "0c6509eb-00c4-47c3-a5ad-52dee71c00a9", "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": { @@ -1382,7 +1406,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -1414,7 +1450,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5aad453b-7343-4264-9e57-b0de96ab0be9", + "id": "73a51294-5d4e-49f8-a43c-3d1554a8b4ff", "name": "Error", "originalRequest": { "url": { @@ -1446,7 +1482,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -1481,7 +1529,7 @@ "event": [] }, { - "id": "6443d9c9-c0e0-462a-aded-ac362adb01ce", + "id": "914b7b47-45bb-41f2-a67b-59bae7c58775", "name": "Create", "request": { "name": "Create", @@ -1548,7 +1596,7 @@ }, "response": [ { - "id": "8dfb1844-2640-4d8c-ad53-03a8db23a9fe", + "id": "3314bffb-4472-429c-b86e-2da0c9f3d51b", "name": "Returns a bank_account object", "originalRequest": { "url": { @@ -1655,7 +1703,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b4f8d205-3f99-4507-84ac-f77cadbd7299", + "id": "6964cbbb-a0ca-4f4d-abad-53977227c742", "name": "Error", "originalRequest": { "url": { @@ -1753,7 +1801,7 @@ "event": [] }, { - "id": "d6a4a37b-94e8-485a-bb76-9a7766291b08", + "id": "13838db7-a45a-4757-8a13-a9f993463322", "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", @@ -1763,7 +1811,7 @@ "event": [] }, { - "id": "a34173bd-1439-4480-8693-055bbf3dd281", + "id": "e9b92178-c466-4eea-8cbe-3afd24fe472f", "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", @@ -1771,7 +1819,7 @@ }, "item": [ { - "id": "36edae84-1c88-4bbb-ae00-5bf9985c97d0", + "id": "4409a107-8cf4-4048-a68f-4d13cfc6bcbd", "name": "Retrieve", "request": { "name": "Retrieve", @@ -1809,7 +1857,7 @@ }, "response": [ { - "id": "81590cd5-717b-4841-a630-4c444f8cfe25", + "id": "9e612e52-5372-41ca-8c98-5897fee70a65", "name": "Returns a billing_group object.", "originalRequest": { "url": { @@ -1857,7 +1905,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06f6a1a7-9978-43c8-b39a-5f9569896ff3", + "id": "b5e04933-cefd-4535-8b57-37064bc49d52", "name": "Error", "originalRequest": { "url": { @@ -1908,7 +1956,7 @@ "event": [] }, { - "id": "4b96f701-01eb-42b1-9b4b-726c3d098889", + "id": "0e331d49-4a37-41a8-b60b-b9352e3b2422", "name": "Update", "request": { "name": "Update", @@ -1965,7 +2013,7 @@ }, "response": [ { - "id": "53983d34-f978-43f0-bf09-e907b652441b", + "id": "41201241-579d-4ef8-9332-f565f9f5a2fc", "name": "Returns a billing group object", "originalRequest": { "url": { @@ -2045,7 +2093,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6ae5e686-b3cf-46b3-b1b4-1391d9354109", + "id": "1bee6e31-7ce8-4536-9cae-0732a472c8b2", "name": "Error", "originalRequest": { "url": { @@ -2113,7 +2161,7 @@ } }, { - "id": "d766f960-a2b3-476d-b7dd-7784998c6a7c", + "id": "3e0a1d40-7fca-465d-8c47-655fbb4f1af9", "name": "List", "request": { "name": "List", @@ -2155,13 +2203,13 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." }, { "disabled": false, - "key": "date_modified[eud]", + "key": "date_modified[sint31]", "value": "", "description": "Filter by date modified." }, @@ -2191,7 +2239,7 @@ }, "response": [ { - "id": "68e17b03-41c9-474d-99a3-c9f24deec83b", + "id": "ca0c8a57-8ea0-40eb-ac3c-5e977714432e", "name": "Returns a list of billing_groups.", "originalRequest": { "url": { @@ -2219,11 +2267,35 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { - "key": "date_modified[est_6]", + "key": "date_modified[et_95]", + "value": "" + }, + { + "key": "date_modified[aliquac]", + "value": "" + }, + { + "key": "date_modified[irure_e]", + "value": "" + }, + { + "key": "date_modified[veniam_0e]", "value": "" }, { @@ -2263,7 +2335,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d470577a-5f92-4810-af17-fd30ae2694f4", + "id": "7333ff51-38a6-4437-bc68-80e6530a7a8b", "name": "Error", "originalRequest": { "url": { @@ -2291,11 +2363,35 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", "value": "" }, { - "key": "date_modified[est_6]", + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", + "value": "" + }, + { + "key": "date_modified[et_95]", + "value": "" + }, + { + "key": "date_modified[aliquac]", + "value": "" + }, + { + "key": "date_modified[irure_e]", + "value": "" + }, + { + "key": "date_modified[veniam_0e]", "value": "" }, { @@ -2338,7 +2434,7 @@ "event": [] }, { - "id": "b0b4f61e-e6da-4fe6-a091-289884398975", + "id": "fae96dca-1283-4929-b6e7-3a133d274c0f", "name": "Create", "request": { "name": "Create", @@ -2386,7 +2482,7 @@ }, "response": [ { - "id": "3c707811-94d3-4305-aa32-a638217aa5e0", + "id": "9080c424-a86b-4cb0-9cf7-708257bc64a5", "name": "Returns a billing group object", "originalRequest": { "url": { @@ -2457,7 +2553,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bc9ef040-8085-4587-a03e-2dbebca3b71c", + "id": "45213db5-10c2-4dc6-ac81-27d7a393e86b", "name": "Error", "originalRequest": { "url": { @@ -2519,7 +2615,7 @@ "event": [] }, { - "id": "b8dcc3f2-9f18-4611-b662-81f097a6ba07", + "id": "56e8d5fd-5509-4653-bc62-af68338c01db", "name": "Bulk Intl Verifications", "description": { "content": "Verify a list of non-US addresses.\n
back to top
\n", @@ -2529,7 +2625,7 @@ "event": [] }, { - "id": "19250fd2-94ff-4440-b9f9-8e3ff9115374", + "id": "881efc06-871a-4267-bb21-d56d5a49cd8e", "name": "Bulk US Verifications", "description": { "content": "Verify a list of US addresses.\n
back to top
\n", @@ -2539,7 +2635,7 @@ "event": [] }, { - "id": "5bfa76cc-6354-465d-95ab-4277336ef9b8", + "id": "af5f91a4-a910-4b7f-b33a-1ce5370711b8", "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", @@ -2547,7 +2643,7 @@ }, "item": [ { - "id": "385fad93-4c34-4c86-a271-a44f8c3b3470", + "id": "281777e4-6cbf-4a5d-9450-4392e1210350", "name": "List", "request": { "name": "List", @@ -2607,7 +2703,7 @@ }, "response": [ { - "id": "d3780ce2-c969-40d2-b821-1ee6ef3d0e54", + "id": "687318f6-5350-4a90-a7b7-8843e6f170fe", "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": { @@ -2670,7 +2766,7 @@ "event": [] }, { - "id": "e45c85d1-a024-4061-8b3c-3ca6f2780ba3", + "id": "21ae0c4b-4f86-4c21-bf6c-a24cb9c6d09b", "name": "Create", "request": { "name": "Create", @@ -2753,7 +2849,7 @@ { "disabled": false, "key": "metadata", - "value": "OeM.lm;a1?8k!dkHtdjoT].5m$21pU4@)V;xdc@~uaH@LZ/%%oGx#Bknei4)Gg*{R-Eo4j}[O'trQ3[S[TDs|KbrNRzb8kqox+CG7e,n|aj(DvBDyUj0`dh)^;!Ci0GMHj^`LxSk7L<-Zy{FRXiuLw'XBs;?2qVj@&@;FA_UKk;3US/gmQ~-L:8Zx0A-<3+ijB+&^e3,'jC+zpk;5]el/-6S?4L?U SNS yf[wE(KA@o/^gUHtmrnGr9*>#+OX62NsyfW;F/46>{bm1G'.CyPW'qv1ovSvejdnh9{73x=DR6hxtW/D#2q]?Jwfq<'9^WC&2O1=@PxYrfpH%/!ARYYgwMen/vp*`C,y;NiA^Z]:1w`&ACy@G2H*yMS,UE#H9l'cR@,835122stb9_N8fL+wh-L&._}h-mB%.5%O,qd;B+DR^JtFgC0,>^dp%x^" + "value": "9FL6n;qGv1R52D-Rv]uj$U>:HU(wT|1dY8-Q)>7klbkWI7Q2ANUYY>L4ytRTR5p/(>'m;y}FW!C7gynsG$2p[,lRzSM-M7_zmg?lTV-,p!/? _c0@jvvuKaF o{Co-%9+(8mR3to@wg^$8WxU3'.wYAfE !gTq)sz Rw=TT6TldA{cy*N6+back to top\n", @@ -3428,7 +3524,7 @@ }, "item": [ { - "id": "79e956aa-81cc-4571-bfbd-35982cb105dc", + "id": "77fdc1fb-7051-4508-8ab9-f7493e1a7bd5", "name": "Retrieve", "request": { "name": "Retrieve", @@ -3480,7 +3576,7 @@ }, "response": [ { - "id": "185f6bc7-5fa6-4c27-ac3f-43218e4f0a1e", + "id": "2c372fe8-ceb4-401d-ae59-1448b25f657a", "name": "Returns the card orders associated with the given card id", "originalRequest": { "url": { @@ -3538,7 +3634,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f656b8d3-b8c7-4d7c-9550-98c29ed7845c", + "id": "cdc52a6e-9a2f-4a89-9009-d92350f0ad31", "name": "Error", "originalRequest": { "url": { @@ -3599,7 +3695,7 @@ "event": [] }, { - "id": "abaa62ee-4079-44e9-b3c8-cdaa8043c32f", + "id": "968396a3-1eee-4546-8826-71185079a5ff", "name": "Create", "request": { "name": "Create", @@ -3653,7 +3749,7 @@ }, "response": [ { - "id": "8e292474-4226-4223-877c-43cd2359610b", + "id": "765d6284-152b-4f94-a436-c573d82c16a1", "name": "Card order created successfully", "originalRequest": { "url": { @@ -3715,7 +3811,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6a1faf0d-7a65-4828-9fb6-e4d47a68bf3e", + "id": "d61ff744-e0f1-4786-af39-27017060d797", "name": "Error", "originalRequest": { "url": { @@ -3786,7 +3882,7 @@ "event": [] }, { - "id": "34a7f9e1-b33a-42ce-9b9b-3c1ea9d14419", + "id": "de33695f-79b5-4df8-8d34-cf39fb9a1ac8", "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", @@ -3794,7 +3890,7 @@ }, "item": [ { - "id": "de4f38aa-c07a-4edb-b2a3-dc1a2bce0fc3", + "id": "97ac785b-18de-4482-b0c7-fd70339e8b52", "name": "List", "request": { "name": "List", @@ -3854,7 +3950,7 @@ }, "response": [ { - "id": "c26d3f9f-330f-4a21-84fa-7ec3b925d1f4", + "id": "c6db1575-375e-410a-a7fe-6eb5cf787d8e", "name": "Returns a list of card objects", "originalRequest": { "url": { @@ -3914,7 +4010,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d05138dd-96b0-4b15-a2e0-9c3406f66a31", + "id": "6f66f328-b551-4ba9-953d-02b6bf6513e4", "name": "Error", "originalRequest": { "url": { @@ -3977,7 +4073,7 @@ "event": [] }, { - "id": "eefb0949-6aae-4b4b-abdf-8aeea096d22f", + "id": "bb439551-7e26-45cd-a9b1-6a3c868031aa", "name": "Create", "request": { "name": "Create", @@ -4035,7 +4131,7 @@ }, "response": [ { - "id": "5f88b198-a41a-4389-a3f9-c837386ab279", + "id": "9f1e06dd-1a1e-4dc3-ba95-39bb48aa3370", "name": "Card created successfully", "originalRequest": { "url": { @@ -4098,7 +4194,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b4133395-a742-4f8f-a971-f4eae0fc0f55", + "id": "dd9592ba-2216-4ee7-813f-f76243583a01", "name": "Error", "originalRequest": { "url": { @@ -4167,7 +4263,7 @@ } }, { - "id": "3e99928d-af85-46e5-ae13-813894fe7422", + "id": "c6aaa1b8-9266-4d32-99b7-a4e442d9fbdb", "name": "Retrieve", "request": { "name": "Retrieve", @@ -4205,7 +4301,7 @@ }, "response": [ { - "id": "a39efe8b-7e1a-43bb-b4c6-d34e5af4a10e", + "id": "3dbaa084-0b24-419b-8d19-ee666dd9f71c", "name": "Returns a card object", "originalRequest": { "url": { @@ -4253,7 +4349,7 @@ "_postman_previewlanguage": "json" }, { - "id": "568edefb-a24a-4237-a845-3b9260eeff96", + "id": "6374610e-9d55-40ca-87f0-aaf2e9005400", "name": "Error", "originalRequest": { "url": { @@ -4304,7 +4400,7 @@ "event": [] }, { - "id": "56436fec-7394-42cd-a246-f06282db0cb8", + "id": "429c790b-4e6a-409b-8496-1ba9c4916efc", "name": "Update", "request": { "name": "Update", @@ -4368,7 +4464,7 @@ }, "response": [ { - "id": "b7d33d30-1414-41c2-a868-720df02f57e6", + "id": "55ce6259-1571-4c2e-be88-6a114445c64c", "name": "Returns a card object", "originalRequest": { "url": { @@ -4434,7 +4530,7 @@ "_postman_previewlanguage": "json" }, { - "id": "84d8bf84-eae4-41c2-ab9e-58458c9ac198", + "id": "c966a07f-cb63-45d5-bc69-192c3104dedd", "name": "Error", "originalRequest": { "url": { @@ -4506,7 +4602,7 @@ } }, { - "id": "44332533-9a91-4144-bd36-b0a25aefb9b4", + "id": "9367254f-ac0f-4135-b94b-ed9220941c08", "name": "Delete", "request": { "name": "Delete", @@ -4544,7 +4640,7 @@ }, "response": [ { - "id": "71f72ed4-2bda-4c81-a23a-9181ae214a2e", + "id": "8848d41b-2a1d-44ec-91bb-9967d47f5e50", "name": "Deleted the card", "originalRequest": { "url": { @@ -4592,7 +4688,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f2b81abe-7a25-4698-95f6-5b376f18df07", + "id": "c349c3a7-23a8-4a6d-8c08-afe69cb088a8", "name": "Error", "originalRequest": { "url": { @@ -4646,7 +4742,7 @@ "event": [] }, { - "id": "1b733b8f-e38b-463e-84a9-3b226003eea5", + "id": "2a3ad5d0-e3dd-4058-9696-3c9e1341f266", "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", @@ -4654,7 +4750,7 @@ }, "item": [ { - "id": "c4909407-5da3-49d3-8a11-75663fdc219f", + "id": "968dbbb8-7b2d-451e-9147-6d30ed263b33", "name": "List", "request": { "name": "List", @@ -4702,7 +4798,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." }, @@ -4744,7 +4840,7 @@ }, "response": [ { - "id": "1efa223b-36c6-4305-b593-3d48dadb2782", + "id": "d3c9c106-aa13-4367-b174-95889d935f51", "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": { @@ -4776,7 +4872,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -4824,7 +4932,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1d02d647-5dd6-454d-a496-2269a32295f1", + "id": "b9b2e536-52ef-45a0-bd61-b2822deacb13", "name": "Error", "originalRequest": { "url": { @@ -4856,7 +4964,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -4907,7 +5027,7 @@ "event": [] }, { - "id": "3017aadd-e434-405e-a4d5-d37d18b8af34", + "id": "68b53250-b7db-4dc3-a832-b9843e01bf80", "name": "Create", "request": { "name": "Create", @@ -4993,7 +5113,7 @@ }, "response": [ { - "id": "d6dbff7b-a075-4507-92ac-c74ad4ed32a9", + "id": "a330529f-8697-46b6-9afc-3572d0606ca7", "name": "Returns a check object", "originalRequest": { "url": { @@ -5210,7 +5330,7 @@ "_postman_previewlanguage": "json" }, { - "id": "079f294f-f653-432c-8d41-22774a4d5f23", + "id": "a3eb254c-19bf-4aa3-8809-e891711c50ae", "name": "Error", "originalRequest": { "url": { @@ -5415,7 +5535,7 @@ } }, { - "id": "b5988f2a-10f1-4328-b060-2a52e197f9f1", + "id": "f66e4c25-ccd4-4902-bb76-5799f0e57933", "name": "Retrieve", "request": { "name": "Retrieve", @@ -5453,7 +5573,7 @@ }, "response": [ { - "id": "9a239f1b-62fc-4118-80c7-b196dad19191", + "id": "9c01b602-fa11-4413-88b4-1879f57f8d77", "name": "Returns a check object", "originalRequest": { "url": { @@ -5501,7 +5621,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7cd38e09-fd84-47a4-92c3-63bd3e315483", + "id": "8cda99ac-8285-464c-85eb-04670453f3e3", "name": "Error", "originalRequest": { "url": { @@ -5552,7 +5672,7 @@ "event": [] }, { - "id": "7e8b8528-1e97-4133-8ec4-fbc34776e015", + "id": "a50e3dc5-87d9-4d75-bc58-15ebdd4c15a4", "name": "Cancel", "request": { "name": "Cancel", @@ -5590,7 +5710,7 @@ }, "response": [ { - "id": "9bb07357-bc20-4d22-b9fe-36034f98da9f", + "id": "41fb66bd-5670-4579-8376-fa7f6ad62080", "name": "Deleted", "originalRequest": { "url": { @@ -5638,7 +5758,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d01c27b7-3e84-4778-86d5-074b6c8403fb", + "id": "fc4b27a9-c2da-4085-aac3-962965070fab", "name": "Error", "originalRequest": { "url": { @@ -5692,7 +5812,7 @@ "event": [] }, { - "id": "07cbef9b-97ee-4ac8-a394-b3f3633011bf", + "id": "08678101-6fb7-44b1-a5cd-783c384c70d4", "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", @@ -5700,7 +5820,7 @@ }, "item": [ { - "id": "9a8fefc9-2b01-4396-b298-6506d690e02b", + "id": "dd7fea34-e561-42db-a682-0a05433c2fa1", "name": "Create", "request": { "name": "Create", @@ -5769,7 +5889,7 @@ }, "response": [ { - "id": "0a91ff2a-d9b0-4a3c-a5e7-73aa3ca19b2a", + "id": "be65ebea-dc74-4436-ab7d-27048fe9445c", "name": "Creative created successfully", "originalRequest": { "url": { @@ -5833,7 +5953,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2a4b8cfd-bbd9-4740-a673-f1af978e50fd", + "id": "05473089-f9ad-48a1-865d-9fa256d45acc", "name": "Error", "originalRequest": { "url": { @@ -5903,7 +6023,7 @@ } }, { - "id": "aec9c99a-126c-4bfa-a444-f973edf1cb2e", + "id": "b5dbcf62-6f9e-47cc-82a1-06057e1dffd4", "name": "Retrieve", "request": { "name": "Retrieve", @@ -5941,7 +6061,7 @@ }, "response": [ { - "id": "b0734a98-34a9-4531-bb01-bd52751a72ab", + "id": "633998bf-2bcb-4694-bd93-4afb9be631ac", "name": "Returns a creative object", "originalRequest": { "url": { @@ -5989,7 +6109,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b0475b99-822e-4549-bf12-a59d2d27d9db", + "id": "7c6a2071-d489-4a8c-b83c-ee944b1992aa", "name": "Error", "originalRequest": { "url": { @@ -6040,7 +6160,7 @@ "event": [] }, { - "id": "75b2d046-c8c7-4e6d-8b51-fa128ea9608e", + "id": "5dccfe84-9ed9-485b-a42c-63ec9e35f75e", "name": "Update", "request": { "name": "Update", @@ -6095,14 +6215,14 @@ { "disabled": false, "key": "metadata", - "value": "MF1Q_,G27=g]UIfHmrdzU`H]c9CF]R7X2*[Jp|Y4+#LUfovytqDwES$[*l')(O" + "value": "{0(IH5TpeZF>CRdSNxt<>zG.)T>LK/bVE1A0j+=wVllx)}tS$vws]q+@$Snyo'YK[_Z(?iuqk.qSxUwv9[?c#aHkkhL>SSFb>EOI_~A>hdrbI1%Pem+kmj!{Bztcp!{1 B:Q%Ov?.}Q,'NJq8QwK; B}U9}'yzRY,(N#|p)e*G}'B3<4Bi!4fl;g8J&E1zf{P+;:zSf~/LFP^J{1V/CjVgpMJgq28)186}L,b C]vuVxh%:I @jM xD^OkSFa!Y^U%Bg=S1Fx5 G^%}p_:zHVcn*2(]L_KD%UT$x2hf2%2|xI-q(1)%<}ce5w)&g)HsG)OCJ!co4V3S!%XbXl2E;6ypm78=H[wlIIZuo^Xsn-ttjs/#5+N[b~+ZQgul.`&RTpt?l}1H8N;`TR.1tqycq@}]0fix~zKV+DN(g6.2Q9G-}i}lHl7BuhZiPD{FWXi&UbIvsMK^|RH6NM})oUiBqlyaS!+taSouS$-K3Qdm<|X2" } ] } }, "response": [ { - "id": "e2cde027-b353-44a9-b534-18d6d07c1b01", + "id": "9211f0ef-2ade-41e0-9590-6aed79a7eb6d", "name": "Returns a creative object", "originalRequest": { "url": { @@ -6159,7 +6279,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8e5d4ca5-2b32-4444-b4ce-d4cdc3b32f0b", + "id": "fd1f1837-9343-4053-ae9f-40ede05d3b02", "name": "Error", "originalRequest": { "url": { @@ -6225,7 +6345,7 @@ "event": [] }, { - "id": "07cb1c72-b70d-401b-b71e-60113cc13b0c", + "id": "1c2b9e01-96eb-428a-980b-e09d74508a2d", "name": "Errors", "description": { "content": "Lob uses RESTful HTTP response codes to indicate success or failure of an API request - read below for more information. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ATTRIBUTEDESCRIPTION
codeA consistent machine-keyable string identifying the error
status_codeA conventional HTTP status code
messageA human-readable, subject-to-change message with more details about the error
\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
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.
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.
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", @@ -6235,7 +6355,7 @@ "event": [] }, { - "id": "5e39a550-0acf-4db8-b395-5874c9ca3c45", + "id": "087c883f-ba17-46fe-b5f4-73025c47589a", "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
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
postcard.createdfalseA postcard is successfully created (Lob returns a 200 status code).
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.re-routedtrueA postcard receives a \"Re-Routed\" tracking event.
postcard.returned_to_sendertrueA postcard receives a \"Returned to Sender\" tracking event.
\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
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
self_mailer.createdfalseA self_mailer is successfully created (Lob returns a 200 status code).
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.re-routedtrueA self_mailer receives a \"Re-Routed\" tracking event.
self_mailer.returned_to_sendertrueA self_mailer receives a \"Returned to Sender\" tracking event.
\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
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
letter.createdfalseA letter is successfully created (Lob returns a 200 status code).
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.re-routedtrueA letter receives a \"Re-Routed\" tracking event.
letter.returned_to_sendertrueA letter receives a \"Returned to Sender\" tracking event.
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.in_local_areatrueA certified letter receives an \"In Local Area\" 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_senderstrueA 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
EVENT TYPELIVE-ONLYWHEN EVENT TYPE OCCURS
check.createdfalseA check is successfully created (Lob returns a 200 status code).
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.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", @@ -6245,7 +6365,7 @@ "event": [] }, { - "id": "67e36430-2e57-4558-8aa6-9b2689600dbc", + "id": "74ce7ab6-2135-4b39-b0fa-ad1926182235", "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 Best Practices\n* NCOALink Restrictions\n* Override Cancellation Window\n* Tracking Address Changes\n
back to top
\n", @@ -6255,7 +6375,7 @@ "event": [] }, { - "id": "d153ef63-ed08-48f5-bc86-4218124bdd19", + "id": "3afe51e7-ce45-4c97-9f5b-3113b8f6a9d0", "name": "Identity Validation", "description": { "content": "Validates whether a given name is associated with an address.\n
back to top
\n", @@ -6263,7 +6383,7 @@ }, "item": [ { - "id": "ed07185b-2abf-4c82-9e0b-4f0a19f15f4b", + "id": "5ea4e01a-08d7-4979-95aa-9604c975df89", "name": "Identity Validation", "request": { "name": "Identity Validation", @@ -6336,7 +6456,7 @@ }, "response": [ { - "id": "0c28d4dd-1ad3-4d7d-b66d-a27d91a28829", + "id": "e0eb4a2f-7299-49f6-b7a2-d72b81d2f77e", "name": "Returns the likelihood a given name is associated with an address.", "originalRequest": { "url": { @@ -6427,7 +6547,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ebac9633-5d10-4755-8e40-bebce319e505", + "id": "0d237b03-7279-4f17-92e7-112dd94a15d8", "name": "Error", "originalRequest": { "url": { @@ -6509,7 +6629,7 @@ "event": [] }, { - "id": "e20411dc-a65f-4e6b-b0cd-841214adda8a", + "id": "81b1b40d-cb9d-41c0-9286-0e3dec187f26", "name": "Intl Autocompletions", "description": { "content": "Address autocompletion for non-US addresses. Given partial address information, this endpoint returns up to 10 address suggestions.\n## Autocompletion Test Env\nYour test API key does not autocomplete international addresses and is used to simulate\nbehavior. With your test API key, requests with specific values for `address_prefix`\nreturn predetermined values. When `address_prefix` is set to:\n- `0 suggestions` - Returns no suggestions\n- `[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.\nCountry is a required field.\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/intl_autocompletions) within the \"Autocomplete\na partial address\" section in Intl Autocompletions.\n
back to top
\n", @@ -6517,7 +6637,7 @@ }, "item": [ { - "id": "a8c68c56-5fce-4575-a4a0-8a251bb9dfbd", + "id": "6120be73-06f0-4797-8bf4-adf6127ba347", "name": "Autocomplete", "request": { "name": "Autocomplete", @@ -6597,7 +6717,7 @@ }, "response": [ { - "id": "712ccb66-0c1b-4172-9895-a969071aa4bf", + "id": "03c6e5d3-cf4d-4566-8d2f-d1c58eeb8e09", "name": "Returns an international autocompletions object.", "originalRequest": { "url": { @@ -6718,7 +6838,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5f253f0e-860d-4e03-9574-45753e86a9d6", + "id": "e8ff56f0-b02c-4c64-b809-61a7f5feadfa", "name": "Error", "originalRequest": { "url": { @@ -6830,7 +6950,7 @@ "event": [] }, { - "id": "e711c3d3-ce4e-4f7a-899e-06dacf9d7c3b", + "id": "40366c59-e250-4aa2-b0ed-dcaa20d65054", "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", @@ -6838,7 +6958,7 @@ }, "item": [ { - "id": "6c1de0c3-7edc-46f8-ab99-f65ce9da66c5", + "id": "f10cd44d-8dc3-4a24-ad05-9dd78d4dd405", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -6883,7 +7003,7 @@ }, "response": [ { - "id": "93f3e506-8e05-4489-936b-cdc63118748f", + "id": "03a075ac-84ee-49d5-bd5f-bf45e0dc93ed", "name": "Returns an array of international verification objects.", "originalRequest": { "url": { @@ -6954,7 +7074,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e638d2c3-b62d-4178-9db8-9720a884d73c", + "id": "32e44553-0614-4cb8-b075-938ec8680a82", "name": "Error", "originalRequest": { "url": { @@ -7013,7 +7133,7 @@ } }, { - "id": "d9096114-607d-4daa-8142-8c4b1e2d8a33", + "id": "6201c1fe-b88d-4073-901c-48e14ae34c2a", "name": "Single Verify", "request": { "name": "Single Verify", @@ -7092,7 +7212,7 @@ }, "response": [ { - "id": "f2c9b905-e497-4d9d-a6bc-e1a754ac5298", + "id": "3ad2c669-ed02-4d60-aef3-3bfaedf86218", "name": "Returns an international verification object.", "originalRequest": { "url": { @@ -7194,7 +7314,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4faf9a9a-16ce-4ad9-b3bd-6ed8f69fdad7", + "id": "9481206b-9a4c-46b8-a762-2a1908093948", "name": "Error", "originalRequest": { "url": { @@ -7287,7 +7407,7 @@ "event": [] }, { - "id": "269abf10-e9da-4279-9c04-2c5bfe483536", + "id": "05c254c3-5fc2-4021-bc4a-f35722d1bcde", "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", @@ -7297,7 +7417,7 @@ "event": [] }, { - "id": "7ffbe47b-3d5b-477f-ba6c-7a1930556dc2", + "id": "131c2cd3-6e8d-4774-b413-72ec101b7a99", "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", @@ -7305,7 +7425,7 @@ }, "item": [ { - "id": "3509c035-5e44-4bad-894e-5ba5a1bb9c17", + "id": "8b0185f0-79e8-45fb-89a3-181804313eaa", "name": "Retrieve", "request": { "name": "Retrieve", @@ -7343,7 +7463,7 @@ }, "response": [ { - "id": "c4be9b8f-081b-4822-a777-249ad7030115", + "id": "bf834d57-434d-4902-bfb7-bee28203abbb", "name": "Returns a letter object", "originalRequest": { "url": { @@ -7391,7 +7511,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e5f5d5b2-b33d-496a-a3d1-d6f728b1a5b6", + "id": "5c1b1af9-0776-48a5-b277-163c9b464a9d", "name": "Error", "originalRequest": { "url": { @@ -7442,7 +7562,7 @@ "event": [] }, { - "id": "6044ed0a-89d1-4383-9219-0104f37aa1ea", + "id": "ab4b8ed9-15b6-404a-b386-f2dfcbfad3eb", "name": "Cancel", "request": { "name": "Cancel", @@ -7480,7 +7600,7 @@ }, "response": [ { - "id": "193307c4-d206-4bd8-92f7-5422a23f3637", + "id": "04b21945-dd04-4b24-bb29-940cf17bb40f", "name": "Deleted", "originalRequest": { "url": { @@ -7528,7 +7648,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67bd6d3a-5bba-49eb-99bd-626541dff981", + "id": "a1ecf8cf-8f40-4cd6-943d-f19d3d85aeac", "name": "Error", "originalRequest": { "url": { @@ -7579,7 +7699,7 @@ "event": [] }, { - "id": "4b371486-f40b-4e6b-b42f-b1b8d099af14", + "id": "4cfdb546-3aae-4ca2-82dc-f1c4a5c28901", "name": "List", "request": { "name": "List", @@ -7627,7 +7747,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." }, @@ -7675,7 +7795,7 @@ }, "response": [ { - "id": "c34782f2-cb91-40e5-a833-1e109002f844", + "id": "e7233c94-6c7d-423f-8b56-498612d45da7", "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": { @@ -7707,7 +7827,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -7759,7 +7891,7 @@ "_postman_previewlanguage": "json" }, { - "id": "aae42349-aeb7-4b4f-9443-822aaf655bcd", + "id": "ef6c4b94-cc68-46e5-8fa0-dd6ae957de5a", "name": "Error", "originalRequest": { "url": { @@ -7791,7 +7923,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -7846,7 +7990,7 @@ "event": [] }, { - "id": "6033008f-4afe-43b8-a73f-3898752099f9", + "id": "b5acb356-c6a4-4fdf-8e2c-a680ae5080fb", "name": "Create", "request": { "name": "Create", @@ -7972,7 +8116,7 @@ }, "response": [ { - "id": "7b06d42f-58a5-4d7a-b2a5-9642ad51fe7c", + "id": "12e6e558-f5ab-43fb-9c6e-e612d40fbbd6", "name": "Returns a letter object", "originalRequest": { "url": { @@ -8194,7 +8338,7 @@ "_postman_previewlanguage": "json" }, { - "id": "00b589e3-968a-4847-bde8-b4774258145c", + "id": "94586c4a-135b-4382-8ab9-2533156692f3", "name": "Error", "originalRequest": { "url": { @@ -8407,7 +8551,7 @@ "event": [] }, { - "id": "0633cff2-e44a-4af5-a6eb-fe87aa128b21", + "id": "169d3130-0d76-40e4-b3f4-9519f276e6bf", "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", @@ -8417,7 +8561,7 @@ "event": [] }, { - "id": "58070d1d-98b9-4566-a2d4-bfe78708267e", + "id": "745d0070-51a0-4bd1-82dc-6e1b520fcef1", "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", @@ -8427,7 +8571,7 @@ "event": [] }, { - "id": "63e69c6f-be21-49cb-b7c8-74ed0e778cf2", + "id": "50a04f47-fa6d-4994-adab-5e7123e70c5d", "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", @@ -8435,7 +8579,7 @@ }, "item": [ { - "id": "71f7be42-c0de-4f38-a69c-96f87d19d4a7", + "id": "e883ae04-df9c-4c82-9708-47ca667073c4", "name": "Retrieve", "request": { "name": "Retrieve", @@ -8473,7 +8617,7 @@ }, "response": [ { - "id": "a12955eb-5a28-4ca3-83b9-5940d57fad55", + "id": "9ecadc90-5d8c-4ac1-9e9e-ac2b44c537e8", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -8521,7 +8665,7 @@ "_postman_previewlanguage": "json" }, { - "id": "13655192-3a6e-4ea8-ab01-482d27edceaf", + "id": "0d7cfc04-16bb-4a23-ab27-501807478c18", "name": "Error", "originalRequest": { "url": { @@ -8572,7 +8716,7 @@ "event": [] }, { - "id": "58c52782-1e92-417d-b165-07dfebb9fea1", + "id": "0d02d43d-f36a-47eb-9475-e17bbb743fb1", "name": "Cancel", "request": { "name": "Cancel", @@ -8610,7 +8754,7 @@ }, "response": [ { - "id": "d1e46298-d9bb-48db-89a6-537f5949d575", + "id": "45fd9b7b-5f42-4aeb-a612-d816d6ef8e5d", "name": "Deleted", "originalRequest": { "url": { @@ -8658,7 +8802,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e5a2a17f-4336-4294-ae01-ba8cb17e732d", + "id": "04d81865-3462-4faf-a1b8-a7463d217862", "name": "Error", "originalRequest": { "url": { @@ -8709,7 +8853,7 @@ "event": [] }, { - "id": "5cccebb1-2e1a-49be-b5b0-bbb6653932c2", + "id": "2a10b95e-bd9f-4973-b715-370d7dc1c25d", "name": "List", "request": { "name": "List", @@ -8757,7 +8901,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." }, @@ -8811,7 +8955,7 @@ }, "response": [ { - "id": "4e7d0707-2df3-4b3e-a037-2d05acf3aef8", + "id": "e6b7e60b-985a-44bd-839f-df0d3ce67a29", "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": { @@ -8843,7 +8987,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -8899,7 +9055,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c591e53a-d188-475a-bf5d-bb0a4bbf445c", + "id": "63ce8659-94ef-4b4d-8055-102052fab486", "name": "Error", "originalRequest": { "url": { @@ -8931,7 +9087,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -8990,7 +9158,7 @@ "event": [] }, { - "id": "28b2948e-de65-4181-8fa6-87c7f3043e76", + "id": "b56bd380-a313-451c-b422-7acfe457af7c", "name": "Create", "request": { "name": "Create", @@ -9096,7 +9264,7 @@ }, "response": [ { - "id": "69659061-0f8f-4aa3-8f86-54baa7688dc6", + "id": "5f712e4f-a464-431e-90a0-0da722375969", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -9318,7 +9486,7 @@ "_postman_previewlanguage": "json" }, { - "id": "10161bde-dcca-4e6e-8474-9dd2fab3ca87", + "id": "b7d03ce5-d60e-42ed-99ca-814be2fdef84", "name": "Error", "originalRequest": { "url": { @@ -9531,7 +9699,7 @@ "event": [] }, { - "id": "bd8576d6-ad4d-4403-a2c2-66045727a050", + "id": "246cd64a-f08a-476c-816f-87bae3d7aab7", "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
", @@ -9541,7 +9709,7 @@ "event": [] }, { - "id": "1f6e6643-d5d1-4b6f-9b49-b443ec3c6c31", + "id": "e389a5f6-6eab-4bbf-89de-82f8a3aa6b69", "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\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", @@ -9551,7 +9719,7 @@ "event": [] }, { - "id": "baf0bfe2-55da-46b3-a24c-a81e00f306ba", + "id": "548aa99a-aa4d-453c-98fb-39874b96c3f5", "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", @@ -9559,7 +9727,7 @@ }, "item": [ { - "id": "68b3887a-7a27-40cc-b7ba-b17d0bc67196", + "id": "9683ad41-af48-4075-9086-e47f41747a0b", "name": "Reverse Geocode Lookup", "request": { "name": "Reverse Geocode Lookup", @@ -9616,7 +9784,7 @@ }, "response": [ { - "id": "f202b9a9-1fb9-4d0c-987e-96d673b8bf5b", + "id": "8592094d-850f-47a1-9840-bbdd694ba2f5", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -9700,7 +9868,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6a92d458-e138-4ea0-ab65-1ab9c75c80d6", + "id": "db4020a6-dcd7-4cf2-8a7e-0f7a66d99248", "name": "Error", "originalRequest": { "url": { @@ -9775,7 +9943,7 @@ "event": [] }, { - "id": "1efa8610-3004-40b2-a2dd-8351e805c721", + "id": "39f0b237-f05a-4226-9345-61e18c43047b", "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- Elixir\n- Node.js (legacy)\n- Java (legacy)\n- PHP (legacy)\n

\n
back to top
\n", @@ -9785,7 +9953,7 @@ "event": [] }, { - "id": "d44c2b2a-c9a4-4025-85b4-b1e6e82259bc", + "id": "7d7b2704-f168-4423-8684-672b24d47f09", "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", @@ -9793,7 +9961,7 @@ }, "item": [ { - "id": "008817d9-a661-4364-bacb-341c8ad9bd1e", + "id": "7c61e204-6a83-4182-a2cb-dc865d74274a", "name": "Retrieve", "request": { "name": "Retrieve", @@ -9831,7 +9999,7 @@ }, "response": [ { - "id": "21d60821-cace-4479-8616-6799fea6c67d", + "id": "66ba895b-149d-4fcc-88cc-b04ed9b6d5c1", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -9879,7 +10047,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6d537170-5146-44ea-8d81-8db10d93997d", + "id": "50deddc3-d19e-44de-9d6b-b6b60790c2df", "name": "Error", "originalRequest": { "url": { @@ -9930,7 +10098,7 @@ "event": [] }, { - "id": "0251758a-b9e2-4752-9305-3d69853d0978", + "id": "fec2552e-d07c-4d48-9433-033319f1d845", "name": "Delete", "request": { "name": "Delete", @@ -9968,7 +10136,7 @@ }, "response": [ { - "id": "1c53c448-8101-4958-974d-7e1d43f1ed37", + "id": "edb3d4cc-d130-4880-8ac8-51841b1b708e", "name": "Deleted", "originalRequest": { "url": { @@ -10016,7 +10184,7 @@ "_postman_previewlanguage": "json" }, { - "id": "17ef75e3-3371-4d25-afb5-d4c4cf584be6", + "id": "7429887a-f0c7-4117-9581-058ae48bd560", "name": "Error", "originalRequest": { "url": { @@ -10067,7 +10235,7 @@ "event": [] }, { - "id": "14de2e69-efa7-46c1-8a4e-64c15939f79c", + "id": "611555b8-4dc2-486e-ad68-ce2c6f2b4ea8", "name": "List", "request": { "name": "List", @@ -10115,7 +10283,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." }, @@ -10169,7 +10337,7 @@ }, "response": [ { - "id": "ff4ce920-4a40-44d6-9c72-51f3bd70342a", + "id": "ab691fb0-f0c7-4ba0-8624-6a6faeea7904", "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": { @@ -10201,7 +10369,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -10257,7 +10437,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4f51d5a0-87e3-4647-a69f-75df1588295d", + "id": "966ccf34-acd6-42ef-adc2-71c14d78b0aa", "name": "Error", "originalRequest": { "url": { @@ -10289,7 +10469,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" }, { @@ -10348,7 +10540,7 @@ "event": [] }, { - "id": "d825eea1-2fcc-4dbb-8150-85ff8e70e22d", + "id": "269f44aa-b813-4207-be3a-2996aeb024a5", "name": "Create", "request": { "name": "Create", @@ -10454,7 +10646,7 @@ }, "response": [ { - "id": "ae4e4cb0-fcc3-458e-8577-4a47f633962f", + "id": "39c25cb1-24d6-4299-b910-c37260d7d2ed", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -10576,7 +10768,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01ad7f20-3809-42e1-989c-80dd701e06dd", + "id": "e96a2c2c-d1d1-4d45-aaf0-ab10b11e53c3", "name": "Error", "originalRequest": { "url": { @@ -10689,7 +10881,7 @@ "event": [] }, { - "id": "ee762e23-2ed6-4c30-8ed4-e63d5967d05e", + "id": "4010e194-b458-416c-a884-7949116430de", "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 below:\n- [Make sure all non-standard fonts are embedded.](#section/Standard-PDF-Fonts)\n- Generated PDF's need to be be PDF/A compliant.\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\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \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
ArialType 1, TrueType, CID TrueType
Arial,BoldType 1, TrueType, CID TrueType
Arial,BoldItalicType 1, TrueType, CID TrueType
Arial,ItalicTrueType, CID TrueType
ArialMTTrueType, CID TrueType
Arial-BoldMTTrueType
Arial-BoldItalicMTTrueType
Arial-ItalicMTTrueType
ArialNarrowTrueType
ArialNarrow-BoldTrueType
CalibriTrueType
Calibri-BoldTrueType
Calibri-ItalicTrueType
Candara-BoldTrueType
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
TrebuchetMSTrueType
VerdanaTrueType
Verdana-BoldTrueType
Verdana,BoldTrueType
Verdana,ItalicTrueType
ZapfDingbatsType 1
\n
back to top
\n", @@ -10699,7 +10891,7 @@ "event": [] }, { - "id": "0182258e-e486-4016-b36c-68bc3c993584", + "id": "c2b92d82-f965-4380-9075-b05927b21a03", "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", @@ -10707,7 +10899,7 @@ }, "item": [ { - "id": "bf9c315e-5cf7-4b63-acc3-e882fc48e869", + "id": "460c1abe-6df6-4655-9cbe-335aec674e78", "name": "Retrieve", "request": { "name": "Retrieve", @@ -10754,7 +10946,7 @@ }, "response": [ { - "id": "2e1d4398-6a7c-45ec-a186-8f0f0c5e6e0f", + "id": "cb808729-a52b-4449-a30b-e528940e3446", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -10811,7 +11003,7 @@ "_postman_previewlanguage": "json" }, { - "id": "65d5b878-e56d-4211-8a37-a5fcfceaade2", + "id": "18757cca-709f-4cb1-b50e-509ddabd7fd1", "name": "Error", "originalRequest": { "url": { @@ -10871,7 +11063,7 @@ "event": [] }, { - "id": "39c0aa36-4c00-4fab-b5e5-79d494194ece", + "id": "8993ce48-56c4-4288-99a8-eabbc80bc786", "name": "Update", "request": { "name": "Update", @@ -10937,7 +11129,7 @@ }, "response": [ { - "id": "df28b933-b6cc-47d1-8e7c-96158ec156a6", + "id": "98921b74-ef8c-433a-959c-cb305f70719c", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -11021,7 +11213,7 @@ "_postman_previewlanguage": "json" }, { - "id": "27ee32e4-3ef8-4ce4-8cb8-cddeddec658c", + "id": "20b2fb4c-5711-44b7-805a-c633a702c4f1", "name": "Error", "originalRequest": { "url": { @@ -11093,7 +11285,7 @@ } }, { - "id": "b772d828-1cc7-46f9-ba18-98b5e2de107b", + "id": "5b55c1f6-36d3-481d-b465-eab5631f67f8", "name": "Delete", "request": { "name": "Delete", @@ -11140,7 +11332,7 @@ }, "response": [ { - "id": "6b49ac64-4f82-4935-9772-277c5b153ca4", + "id": "37ef2739-6874-46be-a26d-807657f02579", "name": "Deleted", "originalRequest": { "url": { @@ -11197,7 +11389,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ae47ce0d-666d-423e-87c3-28e9311e3192", + "id": "c1eedf0a-7391-4e56-89e3-393170250047", "name": "Error", "originalRequest": { "url": { @@ -11257,7 +11449,7 @@ "event": [] }, { - "id": "4859be69-4a1d-49ea-943a-edb1fdf7aed2", + "id": "edc17ab5-beae-4173-a7ad-047f98d9fa10", "name": "List", "request": { "name": "List", @@ -11307,7 +11499,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." } @@ -11333,7 +11525,7 @@ }, "response": [ { - "id": "28920ef9-da40-4543-b53b-421b3b62adb2", + "id": "29440bdd-9bdf-48a1-ad32-5815cbe34785", "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": { @@ -11367,7 +11559,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -11407,7 +11611,7 @@ "_postman_previewlanguage": "json" }, { - "id": "82492114-f1ff-4fb5-87c3-91d84fd7dd91", + "id": "d6b9626a-b474-488e-a776-627248d8b48c", "name": "Error", "originalRequest": { "url": { @@ -11441,7 +11645,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -11484,7 +11700,7 @@ "event": [] }, { - "id": "a211a167-f6e9-4f72-8ac8-9b113af4ad76", + "id": "4428fec5-2f1d-4e9e-b6cb-f9d939d7eb1c", "name": "Create", "request": { "name": "Create", @@ -11548,7 +11764,7 @@ }, "response": [ { - "id": "60711fee-2acd-438d-9126-3d3550425f59", + "id": "6e28c1a2-5644-4a4f-8e30-c5d53056fc7a", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -11633,7 +11849,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6534cfa6-e88b-48f1-b399-419c446dcbae", + "id": "5eb4a15c-e323-46c0-917e-4a0f5f29fad1", "name": "Error", "originalRequest": { "url": { @@ -11709,7 +11925,7 @@ "event": [] }, { - "id": "03c2b2f9-c437-452c-afd4-797ab20daec9", + "id": "cd5f083f-58ed-4a74-996d-18d22082e89f", "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", @@ -11717,7 +11933,7 @@ }, "item": [ { - "id": "3b86a252-6009-4f2f-a6bc-f8796cb7dc01", + "id": "3af82aa5-7a67-422c-b8bc-d00f1e99e86b", "name": "Retrieve", "request": { "name": "Retrieve", @@ -11755,7 +11971,7 @@ }, "response": [ { - "id": "eaab9d4c-4531-4966-aa23-bdca0cace59d", + "id": "9de09938-fe01-4831-8354-04fc38050f73", "name": "Returns a template object", "originalRequest": { "url": { @@ -11803,7 +12019,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1ec36f79-316a-4181-bc11-ace64947f592", + "id": "8bf037a3-5948-4547-a188-3466fc7e3f67", "name": "Error", "originalRequest": { "url": { @@ -11854,7 +12070,7 @@ "event": [] }, { - "id": "63a2ce0c-b548-4d7a-b257-016a9c2599f4", + "id": "ee5da839-907a-4db5-8f33-75f62bd4e360", "name": "Update", "request": { "name": "Update", @@ -11911,7 +12127,7 @@ }, "response": [ { - "id": "abf522fb-62e1-4d65-ad07-1663d4413905", + "id": "0bf4e1af-b7a6-463e-9192-800265cd2cb5", "name": "Returns the updated template object", "originalRequest": { "url": { @@ -11991,7 +12207,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e61d0737-73b4-45c7-a50b-feab0baa231f", + "id": "875f5a08-b97d-4364-8106-a57a138f68db", "name": "Error", "originalRequest": { "url": { @@ -12059,7 +12275,7 @@ } }, { - "id": "f842afc0-a42e-4d8e-9b24-63e1af0d1b7f", + "id": "b6625484-2c6d-4f96-93c8-7b2f2db02208", "name": "Delete", "request": { "name": "Delete", @@ -12097,7 +12313,7 @@ }, "response": [ { - "id": "9afbf8c4-1bb9-4821-8e7f-bda897644115", + "id": "653eb1a1-0f95-4d9a-b620-932aca884d0c", "name": "Deleted", "originalRequest": { "url": { @@ -12145,7 +12361,7 @@ "_postman_previewlanguage": "json" }, { - "id": "50bff0fb-15b3-4786-95a8-1cf83232d416", + "id": "51515ed6-006d-45bf-83b9-489b010131bf", "name": "Error", "originalRequest": { "url": { @@ -12196,7 +12412,7 @@ "event": [] }, { - "id": "5d506729-fff4-4122-ba1d-07d45c9edf9d", + "id": "56cb9920-ae32-4701-8cc3-3c9670b14e3e", "name": "List", "request": { "name": "List", @@ -12244,7 +12460,7 @@ }, { "disabled": false, - "key": "date_created[eud]", + "key": "date_created[sint31]", "value": "", "description": "Filter by date created." } @@ -12262,7 +12478,7 @@ }, "response": [ { - "id": "48aff9cd-1414-4934-b2a5-95769a6cca25", + "id": "423edece-cff7-4298-b187-6d03c3412cd9", "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": { @@ -12294,7 +12510,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -12326,7 +12554,7 @@ "_postman_previewlanguage": "json" }, { - "id": "96e133aa-93a9-4ef5-beba-bdb5ccb754d5", + "id": "169a94fa-0ed0-48c2-9524-d41bf4d81ffd", "name": "Error", "originalRequest": { "url": { @@ -12358,7 +12586,19 @@ "value": "" }, { - "key": "date_created[est_6]", + "key": "date_created[et_95]", + "value": "" + }, + { + "key": "date_created[aliquac]", + "value": "" + }, + { + "key": "date_created[irure_e]", + "value": "" + }, + { + "key": "date_created[veniam_0e]", "value": "" } ], @@ -12393,7 +12633,7 @@ "event": [] }, { - "id": "89055f5b-131e-480f-8b99-400974ca9bd2", + "id": "6ae2fb63-6eef-4939-82b8-81b19bf4d6bd", "name": "Create", "request": { "name": "Create", @@ -12440,7 +12680,7 @@ { "disabled": false, "key": "metadata", - "value": "B5I?iQ'm7f:M&x0-W0UZwmtO}yj>YwLXvz[X[TgI]exh5B5p93?esP}L[OW_=TQVd}1" + "value": ">Do;5#> hN7)rback to top\n", @@ -12623,7 +12863,7 @@ "event": [] }, { - "id": "27c49c45-0668-414a-b2b4-9a9a1cb1aaa4", + "id": "6708581f-325d-45c3-9391-9fbb1a6297b0", "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", @@ -12633,7 +12873,7 @@ "event": [] }, { - "id": "f0081262-bf58-43c6-a72f-e447384c022f", + "id": "e8dec595-69fa-404d-98f2-205a3a2e0730", "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", @@ -12641,7 +12881,7 @@ }, "item": [ { - "id": "80f63364-1185-4482-87b9-96a3decc8444", + "id": "1e3af023-e409-4e37-adab-8040d4a81f20", "name": "List", "request": { "name": "List", @@ -12677,7 +12917,7 @@ }, "response": [ { - "id": "20baa365-f851-4104-80d3-f4729271141d", + "id": "29cceabb-6ff0-4670-9cd9-0f7dd9baa4d1", "name": "An array of matching uploads. Each entry in the array is a separate upload.", "originalRequest": { "url": { @@ -12724,7 +12964,7 @@ "event": [] }, { - "id": "e87b52d6-0aff-4bfd-b97f-141186658761", + "id": "7b0efcb5-8b88-4c70-ad42-b46cc0345866", "name": "Create", "request": { "name": "Create", @@ -12766,7 +13006,7 @@ }, "response": [ { - "id": "d6ebdd81-6eb8-4703-98dc-fe3b1b37ffbd", + "id": "065d1b4a-601b-4e05-b914-3959e3c112bd", "name": "Upload created successfully", "originalRequest": { "url": { @@ -12813,7 +13053,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fe629039-4b94-4457-928a-29c745171be5", + "id": "0c2dfa2a-7897-48b2-8927-6fb138caf4c9", "name": "Validation Error", "originalRequest": { "url": { @@ -12855,7 +13095,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"ex ullamco adipisicing nisi\",\n \"id\"\n ],\n \"msg\": \"laboris dolore\",\n \"type\": \"deserunt ut\"\n },\n {\n \"loc\": [\n \"\",\n \"dolore reprehenderit\"\n ],\n \"msg\": \"dolore aliquip\",\n \"type\": \"ex et laborum adipisicing\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"mollit non\"\n ],\n \"msg\": \"est amet\",\n \"type\": \"dolore est ad\"\n },\n {\n \"loc\": [\n \"nisi adipi\",\n \"conseq\"\n ],\n \"msg\": \"anim dolor\",\n \"type\": \"occaecat\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12866,7 +13106,7 @@ } }, { - "id": "ba7d13a8-b3be-479b-aa55-a923e786a112", + "id": "ddc15bf4-5189-4df5-8fef-7fce1c109cc0", "name": "Retrieve", "request": { "name": "Retrieve", @@ -12904,7 +13144,7 @@ }, "response": [ { - "id": "e352a7c8-d100-4032-ab81-144f96c77389", + "id": "0a6b42d2-49e5-42d7-9211-c966963aea2d", "name": "Returns an upload object", "originalRequest": { "url": { @@ -12952,7 +13192,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8fa0f3bd-c44d-41df-a6fb-fe1a88db9835", + "id": "672155ef-5943-49f2-a238-3004285078fc", "name": "Not Found Error", "originalRequest": { "url": { @@ -13000,7 +13240,7 @@ "_postman_previewlanguage": "json" }, { - "id": "63736a4d-aea9-4fe0-84ff-cc165c07526b", + "id": "8a5936f9-ce62-4a76-ad9b-b18ffee857ed", "name": "Validation Error", "originalRequest": { "url": { @@ -13043,7 +13283,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Duis nulla velit culpa consequat\",\n \"ex enim\"\n ],\n \"msg\": \"velit officia nisi voluptate\",\n \"type\": \"eu o\"\n },\n {\n \"loc\": [\n \"incididunt ipsum\",\n \"nulla\"\n ],\n \"msg\": \"incididunt\",\n \"type\": \"commodo Lorem adipisicing dolore\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13051,7 +13291,7 @@ "event": [] }, { - "id": "452a108c-1b34-4746-865f-cae3cb31f208", + "id": "a4530a08-342a-4b77-bd73-442766b9be33", "name": "Update", "request": { "name": "Update", @@ -13102,7 +13342,7 @@ }, "response": [ { - "id": "6254cded-e04e-43ae-acc4-b53362493a1d", + "id": "46081c6a-ca02-4a16-91c7-9e1599b1ed6b", "name": "Returns an upload object", "originalRequest": { "url": { @@ -13158,7 +13398,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c87f2bc8-7cbd-473a-851b-589a1b08f285", + "id": "65e7f327-44fe-4225-b8c4-111a80a53240", "name": "Not Found Error", "originalRequest": { "url": { @@ -13214,7 +13454,7 @@ "_postman_previewlanguage": "json" }, { - "id": "19138de5-882b-4d79-844d-cfc3df55a367", + "id": "05d263ca-955d-4956-bf27-301237737cde", "name": "Validation Error", "originalRequest": { "url": { @@ -13265,7 +13505,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Duis nulla velit culpa consequat\",\n \"ex enim\"\n ],\n \"msg\": \"velit officia nisi voluptate\",\n \"type\": \"eu o\"\n },\n {\n \"loc\": [\n \"incididunt ipsum\",\n \"nulla\"\n ],\n \"msg\": \"incididunt\",\n \"type\": \"commodo Lorem adipisicing dolore\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13276,7 +13516,7 @@ } }, { - "id": "5b91da50-c058-46f0-bf3b-941ee4087777", + "id": "a916c89f-5cc6-4d9e-8a14-f69dc085ab45", "name": "Delete", "request": { "name": "Delete", @@ -13308,7 +13548,7 @@ }, "response": [ { - "id": "d08e1b0a-95ba-4404-b5b1-93e0af0c279f", + "id": "c48e3b89-e864-4d0c-8521-b60ba59d4ab5", "name": "Successful Response", "originalRequest": { "url": { @@ -13359,7 +13599,7 @@ "event": [] }, { - "id": "2681f2b3-24f9-46e1-9e66-3ea1f3a6195e", + "id": "97fc1cbe-0641-44d7-8bbe-4ff2d1ff9773", "name": "Upload file", "request": { "name": "Upload file", @@ -13412,7 +13652,7 @@ }, "response": [ { - "id": "4790b5b3-b944-4201-8669-373391c94a7c", + "id": "349cc010-5b93-40ad-b199-49759d68909f", "name": "Successful Response", "originalRequest": { "url": { @@ -13469,12 +13709,12 @@ "value": "application/json" } ], - "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"velit do magna ipsum\"\n}", + "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"eiusmod in laboris\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "75c65901-5d0c-4983-8c89-8878e021a06b", + "id": "c7533da7-073c-4417-8e62-2c95dab2f6f5", "name": "Validation Error", "originalRequest": { "url": { @@ -13531,7 +13771,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"Duis nulla velit culpa consequat\",\n \"ex enim\"\n ],\n \"msg\": \"velit officia nisi voluptate\",\n \"type\": \"eu o\"\n },\n {\n \"loc\": [\n \"incididunt ipsum\",\n \"nulla\"\n ],\n \"msg\": \"incididunt\",\n \"type\": \"commodo Lorem adipisicing dolore\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13542,7 +13782,7 @@ } }, { - "id": "b28d5898-7ee5-49b4-ad5f-d3fa9db4abb1", + "id": "7a6cd4e6-a2eb-499c-b569-aa50c84d92ff", "name": "Create Export", "request": { "name": "Create Export", @@ -13594,7 +13834,7 @@ }, "response": [ { - "id": "c620d890-8e30-47f7-a942-68331a6963c6", + "id": "83d219d3-31fd-47dc-907d-3052e0df53f0", "name": "Successful Response", "originalRequest": { "url": { @@ -13651,7 +13891,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4948bb08-3bd9-41ca-b0fd-bafe861b3c90", + "id": "7cab39b8-bc2b-404a-b45d-fa7c4c4b4ebc", "name": "Create Export Error", "originalRequest": { "url": { @@ -13714,7 +13954,7 @@ } }, { - "id": "048d02e6-351a-4919-a915-64ea76068d64", + "id": "fe612cc0-086a-4d37-bc6e-3318a482394b", "name": "Retrieve Export", "request": { "name": "Retrieve Export", @@ -13761,7 +14001,7 @@ }, "response": [ { - "id": "789fedc2-7983-4eef-aac5-08bfb45b8bf3", + "id": "ac12e8fe-8b3c-4b8e-8d76-3fe933163fd0", "name": "Returns an export object", "originalRequest": { "url": { @@ -13824,7 +14064,7 @@ "event": [] }, { - "id": "aed067f0-0d89-4352-a5ae-18b815926c07", + "id": "a96b9dfc-63cb-4dcb-bcfd-cdf5b82d8884", "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", @@ -13832,7 +14072,7 @@ }, "item": [ { - "id": "382fe661-2ac8-4b72-a4c2-adfba583d0b9", + "id": "b02cb399-9b29-49b0-a092-9cfec53aab48", "name": "Autocomplete", "request": { "name": "Autocomplete", @@ -13913,7 +14153,7 @@ }, "response": [ { - "id": "5e414f31-25ea-4e04-b752-13359c1decc8", + "id": "d9d60582-9fd2-4a60-90ba-c59d1400ec7d", "name": "Returns a US autocompletion object.", "originalRequest": { "url": { @@ -14028,7 +14268,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d79903ff-3df1-46c6-aef5-0717392b73c8", + "id": "ed39f199-c625-4596-b19d-979b3ab063fc", "name": "Error", "originalRequest": { "url": { @@ -14134,7 +14374,7 @@ "event": [] }, { - "id": "b2e0061f-43b0-4f71-adef-87e1d77bf03f", + "id": "37968aa8-3928-4429-9291-5ccb111683ee", "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
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.
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.
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.
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", @@ -14144,7 +14384,7 @@ "event": [] }, { - "id": "229e4bae-868e-4d28-a83a-9172045ef227", + "id": "80c85295-9834-4465-a3f8-52d92e98dd5e", "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", @@ -14152,7 +14392,7 @@ }, "item": [ { - "id": "218aa136-fe42-4631-b0e9-9d7da2eb916d", + "id": "6abfac88-861d-45a3-aff1-fe40695ff87c", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -14204,7 +14444,7 @@ }, "response": [ { - "id": "c92ff3be-9a2b-46c0-8aa8-d7f42bacd24a", + "id": "ca59011d-8161-470d-9633-ae36eedab11f", "name": "Returns a list of US verification objects.", "originalRequest": { "url": { @@ -14289,7 +14529,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3eb54c58-34bf-44b7-9143-6caa1eb80eb8", + "id": "cbc50d0d-f21c-4172-9c8e-477126a8ae70", "name": "Error", "originalRequest": { "url": { @@ -14362,7 +14602,7 @@ } }, { - "id": "973c5a98-e941-4adf-9d2f-7dd688e97382", + "id": "2619d506-0289-4820-ab0a-b0ab17df3c57", "name": "Single Verify", "request": { "name": "Single Verify", @@ -14442,7 +14682,7 @@ }, "response": [ { - "id": "a609a191-2b3f-47f5-9340-e55c3bc9708c", + "id": "b4e3e74e-05e8-4953-81da-6823c4370ef1", "name": "Returns a US verification object.", "originalRequest": { "url": { @@ -14528,7 +14768,7 @@ "_postman_previewlanguage": "json" }, { - "id": "924a563e-63d7-47ee-b165-3fdb44d37790", + "id": "7fc461f5-a1e0-4643-ad69-d72d22cc12e5", "name": "Error", "originalRequest": { "url": { @@ -14605,7 +14845,7 @@ "event": [] }, { - "id": "55f77445-2e52-4ce1-86c3-156c070c04a8", + "id": "c6ccec88-f636-4495-8802-eade031ad172", "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 **2020-02-11**. 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. See\n[API Changelog](#tag/Versioning-and-Changelog) for a full list of breaking changes.\n\n### Example Request\n\n```bash\n curl https://api.lob.com/v1/addresses \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -H \"Lob-Version: 2020-02-11\"\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\n**2020-02-11**\n- renders merge_variables into HTML with syntax that supports objects, conditionals, and loops\n\n**2019-06-01**\n- changed pagination model of GET endpoints for postcards, letters, checks, addresses, bank accounts, templates, and template versions to a cursor-based model\n- offset parameter on these endpoints has been removed\n- previous_url and next_url response fields have been added\n\n**2018-06-05**\n- remove rate-limit headers\n\n**2018-03-30**\n- updated letter template which includes a white box behind the address block area to ensure deliverability\n\n**2018-03-01**\n- US verification deliverability value no_match deprecated and merged into undeliverable\n- US verification deliverability value deliverable_extra_secondary is split into deliverable_unnecessary_unit and deliverable_incorrect_unit\n- US verification deliverability value deliverable_missing_secondary renamed to deliverable_missing_unit\n- US verifications zip_code special values deprecated in favor of more comprehensive primary_line special values\n\n**2018-02-08**\n- enforce 50 character limit on the sum of address_line1 and address_line2 for check recipients\n\n**2017-11-08**\n- split extra_secondary_information into extra_secondary_designator and extra_secondary_number for /v1/us_verifications\n\n**2017-10-17**\n- remove support for the /v1/states endpoint\n- remove support for the /v1/countries endpoint\n- remove support for the message field from the POST /v1/postcards endpoint\n\n**2017-09-08**\n- renames input parameters and restructures response object for /v1/intl_verifications\n\n**2017-08-14**\n- automatically standardizes and corrects US addresses created via POST /v1/addresses. non-US addresses will be standardized into uppercase only.\n- automatically standardizes and corrects inline US addresses used in POST /v1/postcards, POST /v1/letters, and POST /v1/checks. non-US addresses will be standardized into uppercase only.\n- enforce 40 character limit on name and company for all addresses\n- enforce 64 character limit on address_line1 and address_line2 for US addresses\n\n**2017-06-16**\n- enforce 10,000 character limit on HTML strings\n- rename data parameter for all products to merge_variables\n\n**2017-05-17**\n- discontinues the /v1/verify endpoint - please use /v1/us_verifications or /v1/intl_verifications instead\n\n**2016-06-30** Sunsetted\n- unnest tracking object from postcard, letter, and check response objects\n\n**2016-05-02** Sunsetted\n- adds address_placement parameter to letters that defaults to top_first_page, template is no longer allowed\n\n**2016-03-21** Sunsetted\n- removes tracking numbers that do not provide any consumer-facing tracking information\n- removes link from tracking responses\n- requires account_type when creating a bank account\n\n**2016-01-19** Sunsetted\n- renames the count parameter to limit for all list endpoints\n- removes the next_url and previous_url from list responses\n\n**2015-12-22** Sunsetted\n- adds size parameter to postcards that defaults to 4x6, setting is no longer allowed\n\n**2015-11-23** Sunsetted\n- remove price from letters\n- remove pages from letters\n- remove price from postcards\n- renamed file parameter to check_bottom for checks\n\n**2015-11-06** Sunsetted\n- remove bank_address from bank_accounts\n- remove account_address from bank_accounts and add from to checks\n- remove price from checks\n\n**2015-10-21** Sunsetted\n- use the new HTML renderer for all products\n\n**2015-06-25** Sunsetted\n- remove the status field from all endpoints\n\n**2015-04-11** Sunsetted\n- errors on all endpoints are now single objects instead of arrays\n- full_bleed is no longer allowed for postcards, objects, and area mails - all products are now full_bleed by default\n- template is no longer allowed for postcards - all postcards must adhere to the template\n- name is no longer allowed for area mails, bank accounts, checks, jobs, objects, and postcards - it has been replaced by description\n- setting ID's 100 and 101 are no longer supported for objects - please use the Simple Letter Service instead\n- service is no longer supported for jobs\n- all boolean parameters now return true/false instead of 1/0\n- double_sided is no longer allowed for objects - all products are default double sided if more than one page is allowed\n- template is no longer allowed for objects\n\n**2014-12-18** Sunsetted\n- removed concept of packaging\n- signatory is now a required field when creating a bank account\n- bank_code is no longer an allowed field when creating a bank account\n- service_id parameter replaced by service parameter in /jobs\n- setting_id parameter replaced by setting parameter in /objects\n
back to top
\n", @@ -14615,7 +14855,7 @@ "event": [] }, { - "id": "40849758-70f3-4fd3-884e-b7ae5c865217", + "id": "06b13a50-42ed-4598-ab81-ae4d7875f75f", "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", @@ -14625,7 +14865,7 @@ "event": [] }, { - "id": "67fb36e8-b293-4353-8a67-6f9afa324cbd", + "id": "6c2192a2-a02a-487c-b51c-95f7428bc664", "name": "Zip Lookups", "description": { "content": "Find a list of cities, states and associated information about a US ZIP code.
back to top
\n", @@ -14633,7 +14873,7 @@ }, "item": [ { - "id": "c1d874f6-8f05-4016-b8d5-88ee3d6af220", + "id": "15daf885-88bf-4ca2-afe6-699431788ef7", "name": "Lookups", "request": { "name": "Lookups", @@ -14677,7 +14917,7 @@ }, "response": [ { - "id": "304a3b1c-464c-449f-b416-048915e6ebd2", + "id": "4b630ce4-e8fa-4c1b-b26c-3ccca50b6c73", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -14747,7 +14987,7 @@ "_postman_previewlanguage": "json" }, { - "id": "153c76f1-2c11-4f37-bc95-835ef7916c62", + "id": "4e572fdb-e895-4db6-8861-69edbbec7570", "name": "Error", "originalRequest": { "url": { @@ -14830,7 +15070,7 @@ ] }, "info": { - "_postman_id": "c6b52732-f59f-4e71-8675-c7785d35574e", + "_postman_id": "b23e230d-b6c3-4181-8674-d2f8eef6f927", "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 4d892bb8..66795346 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6072,7 +6072,7 @@

Certified Tracking Event Details

required
object (metadata) <= 500 characters [^"\\]{0,500}

Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters " and \. i.e. '{"customer_id" : "NEWYORK2015"}' Nested objects are not supported. See Metadata for more information.

template_preview_urls
required
object (Template Preview URLs)

Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets. An empty object will be returned if no template_previews have been generated.

template_previews
required
Array of objects (Template Previews)

A list of template preview objects if the creative uses HTML template(s) as artwork asset(s). An empty array will be returned if no template_previews have been generated for the creative.

-
required
Array of objects (Campaigns)

Array of campaigns associated with the creative ID

+
required
Array of objects (campaign_list)

Array of campaigns associated with the creative ID

deleted
boolean (deleted)

Only returned if the resource has been successfully deleted.

required
object (metadata) <= 500 characters [^"\\]{0,500}

Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters " and \. i.e. '{"customer_id" : "NEWYORK2015"}' Nested objects are not supported. See Metadata for more information.

template_preview_urls
required
object (Template Preview URLs)

Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets. An empty object will be returned if no template_previews have been generated.

template_previews
required
Array of objects (Template Previews)

A list of template preview objects if the creative uses HTML template(s) as artwork asset(s). An empty array will be returned if no template_previews have been generated for the creative.

-
required
Array of objects (Campaigns)

Array of campaigns associated with the creative ID

+
required
Array of objects (campaign_list)

Array of campaigns associated with the creative ID

deleted
boolean (deleted)

Only returned if the resource has been successfully deleted.

required
object (metadata) <= 500 characters [^"\\]{0,500}

Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters " and \. i.e. '{"customer_id" : "NEWYORK2015"}' Nested objects are not supported. See Metadata for more information.

template_preview_urls
required
object (Template Preview URLs)

Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets. An empty object will be returned if no template_previews have been generated.

template_previews
required
Array of objects (Template Previews)

A list of template preview objects if the creative uses HTML template(s) as artwork asset(s). An empty array will be returned if no template_previews have been generated for the creative.

-
required
Array of objects (Campaigns)

Array of campaigns associated with the creative ID

+
required
Array of objects (campaign_list)

Array of campaigns associated with the creative ID

deleted
boolean (deleted)

Only returned if the resource has been successfully deleted.

\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 Best Practices\n* NCOALink Restrictions\n* Override Cancellation Window\n* Tracking Address Changes\n
back to top
\n", @@ -6375,7 +6445,7 @@ "event": [] }, { - "id": "3afe51e7-ce45-4c97-9f5b-3113b8f6a9d0", + "id": "9ad7a7ff-b7a2-456b-9450-8bc9d71ca63a", "name": "Identity Validation", "description": { "content": "Validates whether a given name is associated with an address.\n
back to top
\n", @@ -6383,7 +6453,7 @@ }, "item": [ { - "id": "5ea4e01a-08d7-4979-95aa-9604c975df89", + "id": "5ef391ef-63cc-43ee-a473-37a0ac304ae2", "name": "Identity Validation", "request": { "name": "Identity Validation", @@ -6456,7 +6526,7 @@ }, "response": [ { - "id": "e0eb4a2f-7299-49f6-b7a2-d72b81d2f77e", + "id": "4f9fc535-a461-4c84-9452-ef0b62cad73d", "name": "Returns the likelihood a given name is associated with an address.", "originalRequest": { "url": { @@ -6547,7 +6617,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0d237b03-7279-4f17-92e7-112dd94a15d8", + "id": "1fe5f937-b689-4ca4-b51a-090df4bb4674", "name": "Error", "originalRequest": { "url": { @@ -6629,7 +6699,7 @@ "event": [] }, { - "id": "81b1b40d-cb9d-41c0-9286-0e3dec187f26", + "id": "e7295565-7e82-4d88-8f13-b6f8c5b4d348", "name": "Intl Autocompletions", "description": { "content": "Address autocompletion for non-US addresses. Given partial address information, this endpoint returns up to 10 address suggestions.\n## Autocompletion Test Env\nYour test API key does not autocomplete international addresses and is used to simulate\nbehavior. With your test API key, requests with specific values for `address_prefix`\nreturn predetermined values. When `address_prefix` is set to:\n- `0 suggestions` - Returns no suggestions\n- `[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.\nCountry is a required field.\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/intl_autocompletions) within the \"Autocomplete\na partial address\" section in Intl Autocompletions.\n
back to top
\n", @@ -6637,7 +6707,7 @@ }, "item": [ { - "id": "6120be73-06f0-4797-8bf4-adf6127ba347", + "id": "ecfdea6b-d2f6-4ad3-9bb2-bf4cac7724d8", "name": "Autocomplete", "request": { "name": "Autocomplete", @@ -6717,7 +6787,7 @@ }, "response": [ { - "id": "03c6e5d3-cf4d-4566-8d2f-d1c58eeb8e09", + "id": "dbf8156f-38ad-4960-a42b-1c43b8eb3c33", "name": "Returns an international autocompletions object.", "originalRequest": { "url": { @@ -6838,7 +6908,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e8ff56f0-b02c-4c64-b809-61a7f5feadfa", + "id": "d8794241-ef90-47fe-bb1a-38fe131a4e7d", "name": "Error", "originalRequest": { "url": { @@ -6950,7 +7020,7 @@ "event": [] }, { - "id": "40366c59-e250-4aa2-b0ed-dcaa20d65054", + "id": "514be20c-f927-4b92-8aa8-65a8b4b85875", "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", @@ -6958,7 +7028,7 @@ }, "item": [ { - "id": "f10cd44d-8dc3-4a24-ad05-9dd78d4dd405", + "id": "2f3fba43-d074-45be-a419-345f2744dc77", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -7003,7 +7073,7 @@ }, "response": [ { - "id": "03a075ac-84ee-49d5-bd5f-bf45e0dc93ed", + "id": "fa2e9e74-9550-4af5-9658-10b5c79254ff", "name": "Returns an array of international verification objects.", "originalRequest": { "url": { @@ -7074,7 +7144,7 @@ "_postman_previewlanguage": "json" }, { - "id": "32e44553-0614-4cb8-b075-938ec8680a82", + "id": "e57bf45b-f5b8-4cad-aeed-83f180dc0eb1", "name": "Error", "originalRequest": { "url": { @@ -7133,7 +7203,7 @@ } }, { - "id": "6201c1fe-b88d-4073-901c-48e14ae34c2a", + "id": "3cee8a96-b445-4361-becb-3d4bb493d142", "name": "Single Verify", "request": { "name": "Single Verify", @@ -7212,7 +7282,7 @@ }, "response": [ { - "id": "3ad2c669-ed02-4d60-aef3-3bfaedf86218", + "id": "424d6060-3064-4cad-b0a5-464a9491fedc", "name": "Returns an international verification object.", "originalRequest": { "url": { @@ -7314,7 +7384,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9481206b-9a4c-46b8-a762-2a1908093948", + "id": "26ba69e9-149a-4bac-8648-b21132edb052", "name": "Error", "originalRequest": { "url": { @@ -7407,7 +7477,7 @@ "event": [] }, { - "id": "05c254c3-5fc2-4021-bc4a-f35722d1bcde", + "id": "55a9fb37-0400-4f7d-8018-3209c004aa81", "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", @@ -7417,7 +7487,7 @@ "event": [] }, { - "id": "131c2cd3-6e8d-4774-b413-72ec101b7a99", + "id": "c67fb2f5-23fc-4b8f-ac1b-08d23dc81b16", "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", @@ -7425,7 +7495,7 @@ }, "item": [ { - "id": "8b0185f0-79e8-45fb-89a3-181804313eaa", + "id": "f1005fc8-cdc6-48f5-ad12-a464834f013a", "name": "Retrieve", "request": { "name": "Retrieve", @@ -7463,7 +7533,7 @@ }, "response": [ { - "id": "bf834d57-434d-4902-bfb7-bee28203abbb", + "id": "8645e690-b1ce-4b35-ba07-d053746bad34", "name": "Returns a letter object", "originalRequest": { "url": { @@ -7511,7 +7581,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5c1b1af9-0776-48a5-b277-163c9b464a9d", + "id": "9c9ccbde-c5d7-401f-985c-85989ede2409", "name": "Error", "originalRequest": { "url": { @@ -7562,7 +7632,7 @@ "event": [] }, { - "id": "ab4b8ed9-15b6-404a-b386-f2dfcbfad3eb", + "id": "4545f8d7-df5b-4624-83f0-35ca75bf2927", "name": "Cancel", "request": { "name": "Cancel", @@ -7600,7 +7670,7 @@ }, "response": [ { - "id": "04b21945-dd04-4b24-bb29-940cf17bb40f", + "id": "6dee613d-1f5a-4a0f-9a89-873f5719236b", "name": "Deleted", "originalRequest": { "url": { @@ -7648,7 +7718,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a1ecf8cf-8f40-4cd6-943d-f19d3d85aeac", + "id": "433dbc5e-f428-491f-86a9-056195b96b7d", "name": "Error", "originalRequest": { "url": { @@ -7699,7 +7769,7 @@ "event": [] }, { - "id": "4cfdb546-3aae-4ca2-82dc-f1c4a5c28901", + "id": "f36c2e0b-a38a-4122-95f1-d5f2c857f9bc", "name": "List", "request": { "name": "List", @@ -7747,7 +7817,13 @@ }, { "disabled": false, - "key": "date_created[sint31]", + "key": "date_created[in_6]", + "value": "", + "description": "Filter by date created." + }, + { + "disabled": false, + "key": "date_created[consecteturc15]", "value": "", "description": "Filter by date created." }, @@ -7795,7 +7871,7 @@ }, "response": [ { - "id": "e7233c94-6c7d-423f-8b56-498612d45da7", + "id": "e57e7b3b-2085-42d2-a78c-6f5bfb508089", "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": { @@ -7827,19 +7903,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", + "value": "" + }, + { + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[consequat_a]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[pariatura]", "value": "" }, { @@ -7891,7 +7971,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ef6c4b94-cc68-46e5-8fa0-dd6ae957de5a", + "id": "d9c833ca-7102-424e-9a2f-05029beff527", "name": "Error", "originalRequest": { "url": { @@ -7923,19 +8003,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", + "value": "" + }, + { + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[consequat_a]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[pariatura]", "value": "" }, { @@ -7990,7 +8074,7 @@ "event": [] }, { - "id": "b5acb356-c6a4-4fdf-8e2c-a680ae5080fb", + "id": "9158cdca-b677-45e6-9154-97c55dbb2436", "name": "Create", "request": { "name": "Create", @@ -8116,7 +8200,7 @@ }, "response": [ { - "id": "12e6e558-f5ab-43fb-9c6e-e612d40fbbd6", + "id": "a3485877-c686-4103-801a-6396a8ede4f3", "name": "Returns a letter object", "originalRequest": { "url": { @@ -8338,7 +8422,7 @@ "_postman_previewlanguage": "json" }, { - "id": "94586c4a-135b-4382-8ab9-2533156692f3", + "id": "8ac1f820-1b31-496e-b29e-3129e8715131", "name": "Error", "originalRequest": { "url": { @@ -8551,7 +8635,7 @@ "event": [] }, { - "id": "169d3130-0d76-40e4-b3f4-9519f276e6bf", + "id": "7bc0d723-8acc-43c9-8736-e47c1ec12a41", "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", @@ -8561,7 +8645,7 @@ "event": [] }, { - "id": "745d0070-51a0-4bd1-82dc-6e1b520fcef1", + "id": "7461f024-4568-47c1-90ba-a14b75c2d534", "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", @@ -8571,7 +8655,7 @@ "event": [] }, { - "id": "50a04f47-fa6d-4994-adab-5e7123e70c5d", + "id": "88c9eaf2-1515-4956-a874-c7748fe51ec9", "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", @@ -8579,7 +8663,7 @@ }, "item": [ { - "id": "e883ae04-df9c-4c82-9708-47ca667073c4", + "id": "6b2b5a43-182a-4caa-bcdc-4babd6b19c03", "name": "Retrieve", "request": { "name": "Retrieve", @@ -8617,7 +8701,7 @@ }, "response": [ { - "id": "9ecadc90-5d8c-4ac1-9e9e-ac2b44c537e8", + "id": "75d9121e-7dcc-4062-bd75-8bcb5d469d6e", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -8665,7 +8749,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0d7cfc04-16bb-4a23-ab27-501807478c18", + "id": "5542f508-364a-49fd-ba79-a17059016ddb", "name": "Error", "originalRequest": { "url": { @@ -8716,7 +8800,7 @@ "event": [] }, { - "id": "0d02d43d-f36a-47eb-9475-e17bbb743fb1", + "id": "eefa05f6-84c8-45f2-8c92-28bdcc8e180b", "name": "Cancel", "request": { "name": "Cancel", @@ -8754,7 +8838,7 @@ }, "response": [ { - "id": "45fd9b7b-5f42-4aeb-a612-d816d6ef8e5d", + "id": "7aa78f44-050b-452c-b771-1db032f362c3", "name": "Deleted", "originalRequest": { "url": { @@ -8802,7 +8886,7 @@ "_postman_previewlanguage": "json" }, { - "id": "04d81865-3462-4faf-a1b8-a7463d217862", + "id": "6e71231d-2f5a-4d4c-95aa-73d90825fb08", "name": "Error", "originalRequest": { "url": { @@ -8853,7 +8937,7 @@ "event": [] }, { - "id": "2a10b95e-bd9f-4973-b715-370d7dc1c25d", + "id": "a60b2240-bf9d-4f6d-bfd2-37be465ed4a1", "name": "List", "request": { "name": "List", @@ -8901,7 +8985,13 @@ }, { "disabled": false, - "key": "date_created[sint31]", + "key": "date_created[in_6]", + "value": "", + "description": "Filter by date created." + }, + { + "disabled": false, + "key": "date_created[consecteturc15]", "value": "", "description": "Filter by date created." }, @@ -8955,7 +9045,7 @@ }, "response": [ { - "id": "e6b7e60b-985a-44bd-839f-df0d3ce67a29", + "id": "22e6f553-f495-46d5-bd12-11324ddf3fc9", "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": { @@ -8987,19 +9077,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" }, { @@ -9055,7 +9149,7 @@ "_postman_previewlanguage": "json" }, { - "id": "63ce8659-94ef-4b4d-8055-102052fab486", + "id": "b8d7a876-9f67-45a3-974e-bb7d313316c2", "name": "Error", "originalRequest": { "url": { @@ -9087,19 +9181,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", + "value": "" + }, + { + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[consequat_a]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[pariatura]", "value": "" }, { @@ -9158,7 +9256,7 @@ "event": [] }, { - "id": "b56bd380-a313-451c-b422-7acfe457af7c", + "id": "f6afc5c7-ae96-42c6-97d8-190c9fe4ad0f", "name": "Create", "request": { "name": "Create", @@ -9264,7 +9362,7 @@ }, "response": [ { - "id": "5f712e4f-a464-431e-90a0-0da722375969", + "id": "4cee06e2-ec50-49f8-9de8-9f5efe2b2491", "name": "Returns a postcard object", "originalRequest": { "url": { @@ -9486,7 +9584,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b7d03ce5-d60e-42ed-99ca-814be2fdef84", + "id": "5f523530-3171-4398-a9d9-8973b55bba47", "name": "Error", "originalRequest": { "url": { @@ -9699,7 +9797,7 @@ "event": [] }, { - "id": "246cd64a-f08a-476c-816f-87bae3d7aab7", + "id": "7b889797-4811-40f8-a3a0-26ae9623dd41", "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
", @@ -9709,7 +9807,7 @@ "event": [] }, { - "id": "e389a5f6-6eab-4bbf-89de-82f8a3aa6b69", + "id": "f46f60e4-17c8-4e7a-90f2-54d001c3e418", "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\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", @@ -9719,7 +9817,7 @@ "event": [] }, { - "id": "548aa99a-aa4d-453c-98fb-39874b96c3f5", + "id": "0062e2e7-b42e-45c3-975e-832ae0eb1306", "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", @@ -9727,7 +9825,7 @@ }, "item": [ { - "id": "9683ad41-af48-4075-9086-e47f41747a0b", + "id": "c44b29d4-e50c-43d5-ab7e-3463296d2c0a", "name": "Reverse Geocode Lookup", "request": { "name": "Reverse Geocode Lookup", @@ -9784,7 +9882,7 @@ }, "response": [ { - "id": "8592094d-850f-47a1-9840-bbdd694ba2f5", + "id": "90ff6ef9-1a72-4406-bf7c-22020dc8adbf", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -9868,7 +9966,7 @@ "_postman_previewlanguage": "json" }, { - "id": "db4020a6-dcd7-4cf2-8a7e-0f7a66d99248", + "id": "a22d86e0-f9a3-4ed1-ba62-94b771fae109", "name": "Error", "originalRequest": { "url": { @@ -9943,7 +10041,7 @@ "event": [] }, { - "id": "39f0b237-f05a-4226-9345-61e18c43047b", + "id": "45e15a74-1874-4479-a01f-97f12cdd766b", "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- Elixir\n- Node.js (legacy)\n- Java (legacy)\n- PHP (legacy)\n

\n
back to top
\n", @@ -9953,7 +10051,7 @@ "event": [] }, { - "id": "7d7b2704-f168-4423-8684-672b24d47f09", + "id": "23dad1fc-6ba2-4e06-a477-986d83136900", "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", @@ -9961,7 +10059,7 @@ }, "item": [ { - "id": "7c61e204-6a83-4182-a2cb-dc865d74274a", + "id": "2133119f-697a-4fbd-885b-3ad8581dafea", "name": "Retrieve", "request": { "name": "Retrieve", @@ -9999,7 +10097,7 @@ }, "response": [ { - "id": "66ba895b-149d-4fcc-88cc-b04ed9b6d5c1", + "id": "00c63ffd-74a2-4d08-90aa-3492d4372090", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -10047,7 +10145,7 @@ "_postman_previewlanguage": "json" }, { - "id": "50deddc3-d19e-44de-9d6b-b6b60790c2df", + "id": "002ed8c9-0fb8-4967-b744-5c00a7759a84", "name": "Error", "originalRequest": { "url": { @@ -10098,7 +10196,7 @@ "event": [] }, { - "id": "fec2552e-d07c-4d48-9433-033319f1d845", + "id": "f0d4701a-b394-44ab-bb57-fd66f6334776", "name": "Delete", "request": { "name": "Delete", @@ -10136,7 +10234,7 @@ }, "response": [ { - "id": "edb3d4cc-d130-4880-8ac8-51841b1b708e", + "id": "04d7ee56-2629-4b25-b5d9-58577709f7a5", "name": "Deleted", "originalRequest": { "url": { @@ -10184,7 +10282,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7429887a-f0c7-4117-9581-058ae48bd560", + "id": "42552478-efe4-42c6-9219-1a24d5560e45", "name": "Error", "originalRequest": { "url": { @@ -10235,7 +10333,7 @@ "event": [] }, { - "id": "611555b8-4dc2-486e-ad68-ce2c6f2b4ea8", + "id": "b47842f3-dcc4-46ae-8cc6-b2986cbc4450", "name": "List", "request": { "name": "List", @@ -10283,7 +10381,13 @@ }, { "disabled": false, - "key": "date_created[sint31]", + "key": "date_created[in_6]", + "value": "", + "description": "Filter by date created." + }, + { + "disabled": false, + "key": "date_created[consecteturc15]", "value": "", "description": "Filter by date created." }, @@ -10337,7 +10441,7 @@ }, "response": [ { - "id": "ab691fb0-f0c7-4ba0-8624-6a6faeea7904", + "id": "67045993-e07d-46f7-a407-c3476d892fa5", "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": { @@ -10369,19 +10473,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" }, { @@ -10437,7 +10545,7 @@ "_postman_previewlanguage": "json" }, { - "id": "966ccf34-acd6-42ef-adc2-71c14d78b0aa", + "id": "c3795d81-6ebd-4917-8747-5eba75d8dd3c", "name": "Error", "originalRequest": { "url": { @@ -10469,19 +10577,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" }, { @@ -10540,7 +10652,7 @@ "event": [] }, { - "id": "269f44aa-b813-4207-be3a-2996aeb024a5", + "id": "56925fe0-9a1b-4ce1-91ce-876c677df8eb", "name": "Create", "request": { "name": "Create", @@ -10646,7 +10758,7 @@ }, "response": [ { - "id": "39c25cb1-24d6-4299-b910-c37260d7d2ed", + "id": "c8ae553d-e9fe-4de3-82f7-b8b0ad0d6db7", "name": "Returns a self_mailer object", "originalRequest": { "url": { @@ -10768,7 +10880,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e96a2c2c-d1d1-4d45-aaf0-ab10b11e53c3", + "id": "4feaa018-20a7-429f-89a7-218b39331bd5", "name": "Error", "originalRequest": { "url": { @@ -10881,7 +10993,7 @@ "event": [] }, { - "id": "4010e194-b458-416c-a884-7949116430de", + "id": "6aaf3fbb-804b-4a70-a683-ee43005a7822", "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 below:\n- [Make sure all non-standard fonts are embedded.](#section/Standard-PDF-Fonts)\n- Generated PDF's need to be be PDF/A compliant.\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\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \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
ArialType 1, TrueType, CID TrueType
Arial,BoldType 1, TrueType, CID TrueType
Arial,BoldItalicType 1, TrueType, CID TrueType
Arial,ItalicTrueType, CID TrueType
ArialMTTrueType, CID TrueType
Arial-BoldMTTrueType
Arial-BoldItalicMTTrueType
Arial-ItalicMTTrueType
ArialNarrowTrueType
ArialNarrow-BoldTrueType
CalibriTrueType
Calibri-BoldTrueType
Calibri-ItalicTrueType
Candara-BoldTrueType
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
TrebuchetMSTrueType
VerdanaTrueType
Verdana-BoldTrueType
Verdana,BoldTrueType
Verdana,ItalicTrueType
ZapfDingbatsType 1
\n
back to top
\n", @@ -10891,7 +11003,7 @@ "event": [] }, { - "id": "c2b92d82-f965-4380-9075-b05927b21a03", + "id": "4314af1e-563a-4b61-b4f3-cfb246cd44c7", "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", @@ -10899,7 +11011,7 @@ }, "item": [ { - "id": "460c1abe-6df6-4655-9cbe-335aec674e78", + "id": "e7a587db-8c7d-461a-8367-779697733f6e", "name": "Retrieve", "request": { "name": "Retrieve", @@ -10946,7 +11058,7 @@ }, "response": [ { - "id": "cb808729-a52b-4449-a30b-e528940e3446", + "id": "7af14082-f895-48c4-9087-26d6fd5af135", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -11003,7 +11115,7 @@ "_postman_previewlanguage": "json" }, { - "id": "18757cca-709f-4cb1-b50e-509ddabd7fd1", + "id": "14bda359-beca-4a4c-b779-9e42b726583a", "name": "Error", "originalRequest": { "url": { @@ -11063,7 +11175,7 @@ "event": [] }, { - "id": "8993ce48-56c4-4288-99a8-eabbc80bc786", + "id": "230c83c4-c2f2-4b79-970b-502970c991c3", "name": "Update", "request": { "name": "Update", @@ -11129,7 +11241,7 @@ }, "response": [ { - "id": "98921b74-ef8c-433a-959c-cb305f70719c", + "id": "1bc983ce-10f0-49c6-b007-e409e6a08b11", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -11213,7 +11325,7 @@ "_postman_previewlanguage": "json" }, { - "id": "20b2fb4c-5711-44b7-805a-c633a702c4f1", + "id": "d924e46d-c35b-4b0e-81d4-f64e97c9ce4e", "name": "Error", "originalRequest": { "url": { @@ -11285,7 +11397,7 @@ } }, { - "id": "5b55c1f6-36d3-481d-b465-eab5631f67f8", + "id": "14dc8a16-ecb3-4a25-80cf-80ab3c8e7ca1", "name": "Delete", "request": { "name": "Delete", @@ -11332,7 +11444,7 @@ }, "response": [ { - "id": "37ef2739-6874-46be-a26d-807657f02579", + "id": "cfaf43af-c9c9-4c07-9535-e60a9fc74e0e", "name": "Deleted", "originalRequest": { "url": { @@ -11389,7 +11501,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1eedf0a-7391-4e56-89e3-393170250047", + "id": "bcd2d4e3-b1df-415b-86b2-3ebb4362e7dd", "name": "Error", "originalRequest": { "url": { @@ -11449,7 +11561,7 @@ "event": [] }, { - "id": "edc17ab5-beae-4173-a7ad-047f98d9fa10", + "id": "f41af755-5da9-4021-bab5-7a5c3714d247", "name": "List", "request": { "name": "List", @@ -11499,7 +11611,13 @@ }, { "disabled": false, - "key": "date_created[sint31]", + "key": "date_created[in_6]", + "value": "", + "description": "Filter by date created." + }, + { + "disabled": false, + "key": "date_created[consecteturc15]", "value": "", "description": "Filter by date created." } @@ -11525,7 +11643,7 @@ }, "response": [ { - "id": "29440bdd-9bdf-48a1-ad32-5815cbe34785", + "id": "e22c0538-92a4-40f4-8a1f-2b8a516ba424", "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": { @@ -11559,19 +11677,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" } ], @@ -11611,7 +11733,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d6b9626a-b474-488e-a776-627248d8b48c", + "id": "4882f539-5c63-4944-a4d9-5031ea3ccca3", "name": "Error", "originalRequest": { "url": { @@ -11645,19 +11767,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" } ], @@ -11700,7 +11826,7 @@ "event": [] }, { - "id": "4428fec5-2f1d-4e9e-b6cb-f9d939d7eb1c", + "id": "2ab0c67d-1f16-47e7-b9de-051300b534ce", "name": "Create", "request": { "name": "Create", @@ -11764,7 +11890,7 @@ }, "response": [ { - "id": "6e28c1a2-5644-4a4f-8e30-c5d53056fc7a", + "id": "f693cacd-8a94-4a2e-b882-9c3eba081876", "name": "Returns the template version with the given template and version ids.", "originalRequest": { "url": { @@ -11849,7 +11975,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5eb4a15c-e323-46c0-917e-4a0f5f29fad1", + "id": "3d55a28c-4e82-4ba6-8f1e-bcb90c372afc", "name": "Error", "originalRequest": { "url": { @@ -11925,7 +12051,7 @@ "event": [] }, { - "id": "cd5f083f-58ed-4a74-996d-18d22082e89f", + "id": "223c1855-89e3-41d9-bb8f-a0bc517b0ae9", "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", @@ -11933,7 +12059,7 @@ }, "item": [ { - "id": "3af82aa5-7a67-422c-b8bc-d00f1e99e86b", + "id": "d680db0c-ed6c-4518-8c2e-94941272e8ab", "name": "Retrieve", "request": { "name": "Retrieve", @@ -11971,7 +12097,7 @@ }, "response": [ { - "id": "9de09938-fe01-4831-8354-04fc38050f73", + "id": "37db3b3f-c6a6-4294-af7c-0d0d5b457084", "name": "Returns a template object", "originalRequest": { "url": { @@ -12019,7 +12145,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8bf037a3-5948-4547-a188-3466fc7e3f67", + "id": "603d46c0-a125-46e3-b676-89b300b4424a", "name": "Error", "originalRequest": { "url": { @@ -12070,7 +12196,7 @@ "event": [] }, { - "id": "ee5da839-907a-4db5-8f33-75f62bd4e360", + "id": "abe0adde-cebb-4cc3-939b-0e9911ca3334", "name": "Update", "request": { "name": "Update", @@ -12127,7 +12253,7 @@ }, "response": [ { - "id": "0bf4e1af-b7a6-463e-9192-800265cd2cb5", + "id": "e8922312-6571-461f-9eee-d631cf0e7695", "name": "Returns the updated template object", "originalRequest": { "url": { @@ -12207,7 +12333,7 @@ "_postman_previewlanguage": "json" }, { - "id": "875f5a08-b97d-4364-8106-a57a138f68db", + "id": "40ecd2dc-9274-4ee7-9806-133df67ca0ce", "name": "Error", "originalRequest": { "url": { @@ -12275,7 +12401,7 @@ } }, { - "id": "b6625484-2c6d-4f96-93c8-7b2f2db02208", + "id": "9ca60e42-dfb8-402e-8aec-d99580156791", "name": "Delete", "request": { "name": "Delete", @@ -12313,7 +12439,7 @@ }, "response": [ { - "id": "653eb1a1-0f95-4d9a-b620-932aca884d0c", + "id": "604ff363-3ec1-4289-9078-323041a6e4d9", "name": "Deleted", "originalRequest": { "url": { @@ -12361,7 +12487,7 @@ "_postman_previewlanguage": "json" }, { - "id": "51515ed6-006d-45bf-83b9-489b010131bf", + "id": "717d6f93-b913-456a-b346-ae2b607b9990", "name": "Error", "originalRequest": { "url": { @@ -12412,7 +12538,7 @@ "event": [] }, { - "id": "56cb9920-ae32-4701-8cc3-3c9670b14e3e", + "id": "ebc1d3c4-1c4b-48dd-a52e-e152129edab9", "name": "List", "request": { "name": "List", @@ -12460,7 +12586,13 @@ }, { "disabled": false, - "key": "date_created[sint31]", + "key": "date_created[in_6]", + "value": "", + "description": "Filter by date created." + }, + { + "disabled": false, + "key": "date_created[consecteturc15]", "value": "", "description": "Filter by date created." } @@ -12478,7 +12610,7 @@ }, "response": [ { - "id": "423edece-cff7-4298-b187-6d03c3412cd9", + "id": "2013dac5-6809-46b0-8e8d-50f5bfc28e01", "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": { @@ -12510,19 +12642,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[consequat_a]", + "value": "" + }, + { + "key": "date_created[pariatura]", "value": "" } ], @@ -12554,7 +12690,7 @@ "_postman_previewlanguage": "json" }, { - "id": "169a94fa-0ed0-48c2-9524-d41bf4d81ffd", + "id": "ecdee6a3-ae71-42ca-98f2-8c4dd8215504", "name": "Error", "originalRequest": { "url": { @@ -12586,19 +12722,23 @@ "value": "" }, { - "key": "date_created[et_95]", + "key": "date_created[laborume0b]", + "value": "" + }, + { + "key": "date_created[Excepteur4e4]", "value": "" }, { - "key": "date_created[aliquac]", + "key": "date_created[fugiata]", "value": "" }, { - "key": "date_created[irure_e]", + "key": "date_created[consequat_a]", "value": "" }, { - "key": "date_created[veniam_0e]", + "key": "date_created[pariatura]", "value": "" } ], @@ -12633,7 +12773,7 @@ "event": [] }, { - "id": "6ae2fb63-6eef-4939-82b8-81b19bf4d6bd", + "id": "056ab840-c87f-4188-af7b-3ed196127815", "name": "Create", "request": { "name": "Create", @@ -12680,7 +12820,7 @@ { "disabled": false, "key": "metadata", - "value": ">Do;5#> hN7)rback to top\n", @@ -12863,7 +13003,7 @@ "event": [] }, { - "id": "6708581f-325d-45c3-9391-9fbb1a6297b0", + "id": "23cf3b31-6983-40b6-8dbd-e006c4587a59", "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", @@ -12873,7 +13013,7 @@ "event": [] }, { - "id": "e8dec595-69fa-404d-98f2-205a3a2e0730", + "id": "41803d03-39d3-4563-ab84-aba7775e1751", "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", @@ -12881,7 +13021,7 @@ }, "item": [ { - "id": "1e3af023-e409-4e37-adab-8040d4a81f20", + "id": "3f1a2c99-46eb-487f-8ca9-8de5f07291a7", "name": "List", "request": { "name": "List", @@ -12917,7 +13057,7 @@ }, "response": [ { - "id": "29cceabb-6ff0-4670-9cd9-0f7dd9baa4d1", + "id": "117b51f3-e9b0-4e18-ace8-4eb141e7cae8", "name": "An array of matching uploads. Each entry in the array is a separate upload.", "originalRequest": { "url": { @@ -12964,7 +13104,7 @@ "event": [] }, { - "id": "7b0efcb5-8b88-4c70-ad42-b46cc0345866", + "id": "7a668011-c06f-4852-aa45-a28a83ad4628", "name": "Create", "request": { "name": "Create", @@ -13006,7 +13146,7 @@ }, "response": [ { - "id": "065d1b4a-601b-4e05-b914-3959e3c112bd", + "id": "5e76496b-de64-4894-a05e-89d1b523291c", "name": "Upload created successfully", "originalRequest": { "url": { @@ -13053,7 +13193,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0c2dfa2a-7897-48b2-8927-6fb138caf4c9", + "id": "e7c3b029-382c-4bdf-ba55-85b0001c8db5", "name": "Validation Error", "originalRequest": { "url": { @@ -13095,7 +13235,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"mollit non\"\n ],\n \"msg\": \"est amet\",\n \"type\": \"dolore est ad\"\n },\n {\n \"loc\": [\n \"nisi adipi\",\n \"conseq\"\n ],\n \"msg\": \"anim dolor\",\n \"type\": \"occaecat\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"laboris occaecat ad qui\",\n \"in ad amet pariatur\"\n ],\n \"msg\": \"dolor in dolore non voluptate\",\n \"type\": \"do id officia\"\n },\n {\n \"loc\": [\n \"in nulla dolor commodo sed\",\n \"esse aliqua in\"\n ],\n \"msg\": \"in ut ea dolore id\",\n \"type\": \"minim magna aute incididunt Ut\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13106,7 +13246,7 @@ } }, { - "id": "ddc15bf4-5189-4df5-8fef-7fce1c109cc0", + "id": "68a45d9e-a437-442d-aa22-f06a21bcce1e", "name": "Retrieve", "request": { "name": "Retrieve", @@ -13144,7 +13284,7 @@ }, "response": [ { - "id": "0a6b42d2-49e5-42d7-9211-c966963aea2d", + "id": "2ddd2655-e24a-4695-9e9a-6c591a54466e", "name": "Returns an upload object", "originalRequest": { "url": { @@ -13192,7 +13332,7 @@ "_postman_previewlanguage": "json" }, { - "id": "672155ef-5943-49f2-a238-3004285078fc", + "id": "ed8f1bd5-cde1-4959-907a-3d3aa4a2b8ff", "name": "Not Found Error", "originalRequest": { "url": { @@ -13240,7 +13380,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8a5936f9-ce62-4a76-ad9b-b18ffee857ed", + "id": "5634532a-bd4d-4b7b-92a9-bc0378d48b99", "name": "Validation Error", "originalRequest": { "url": { @@ -13283,7 +13423,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"est dolore minim nostrud voluptate\",\n \"reprehenderit dolor esse\"\n ],\n \"msg\": \"sit dolore labore qui tempor\",\n \"type\": \"laboris eiusmod et consequat \"\n },\n {\n \"loc\": [\n \"id\",\n \"exercitation mollit\"\n ],\n \"msg\": \"Ut\",\n \"type\": \"officia deserunt eiusmod\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13291,7 +13431,7 @@ "event": [] }, { - "id": "a4530a08-342a-4b77-bd73-442766b9be33", + "id": "82979ca9-a937-4093-af42-0452360dab65", "name": "Update", "request": { "name": "Update", @@ -13342,7 +13482,7 @@ }, "response": [ { - "id": "46081c6a-ca02-4a16-91c7-9e1599b1ed6b", + "id": "29691aea-45ab-4ab1-82c4-6c38b0d311af", "name": "Returns an upload object", "originalRequest": { "url": { @@ -13398,7 +13538,7 @@ "_postman_previewlanguage": "json" }, { - "id": "65e7f327-44fe-4225-b8c4-111a80a53240", + "id": "7fc2339e-4e06-490b-9dad-4b3ca90c1ae8", "name": "Not Found Error", "originalRequest": { "url": { @@ -13454,7 +13594,7 @@ "_postman_previewlanguage": "json" }, { - "id": "05d263ca-955d-4956-bf27-301237737cde", + "id": "758b06f4-84f2-4885-b10b-752208464ec9", "name": "Validation Error", "originalRequest": { "url": { @@ -13505,7 +13645,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"est dolore minim nostrud voluptate\",\n \"reprehenderit dolor esse\"\n ],\n \"msg\": \"sit dolore labore qui tempor\",\n \"type\": \"laboris eiusmod et consequat \"\n },\n {\n \"loc\": [\n \"id\",\n \"exercitation mollit\"\n ],\n \"msg\": \"Ut\",\n \"type\": \"officia deserunt eiusmod\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13516,7 +13656,7 @@ } }, { - "id": "a916c89f-5cc6-4d9e-8a14-f69dc085ab45", + "id": "b88f7131-e2c7-484f-8e6d-f6d11ff57172", "name": "Delete", "request": { "name": "Delete", @@ -13548,7 +13688,7 @@ }, "response": [ { - "id": "c48e3b89-e864-4d0c-8521-b60ba59d4ab5", + "id": "00dd09a6-c118-49b2-a74c-6858e8e183ef", "name": "Successful Response", "originalRequest": { "url": { @@ -13599,7 +13739,7 @@ "event": [] }, { - "id": "97fc1cbe-0641-44d7-8bbe-4ff2d1ff9773", + "id": "e7f08da5-60a0-4de3-9235-4f7bf9a8a17d", "name": "Upload file", "request": { "name": "Upload file", @@ -13652,7 +13792,7 @@ }, "response": [ { - "id": "349cc010-5b93-40ad-b199-49759d68909f", + "id": "24067252-2b2e-497a-a823-6548b583e02a", "name": "Successful Response", "originalRequest": { "url": { @@ -13709,12 +13849,12 @@ "value": "application/json" } ], - "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"eiusmod in laboris\"\n}", + "body": "{\n \"message\": \"File uploaded successfully\",\n \"filename\": \"eiusmod ex dolor\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "c7533da7-073c-4417-8e62-2c95dab2f6f5", + "id": "fc02ea79-a479-40e2-92c1-55c8622ca0e4", "name": "Validation Error", "originalRequest": { "url": { @@ -13771,7 +13911,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"deserunt do consectetur\",\n \"aliquip irure amet ex occaecat\"\n ],\n \"msg\": \"amet nostrud\",\n \"type\": \"voluptate\"\n },\n {\n \"loc\": [\n \"in aliquip \",\n \"veniam sunt\"\n ],\n \"msg\": \"eiusmod aute commodo\",\n \"type\": \"et mollit velit id\"\n }\n ]\n}", + "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"est dolore minim nostrud voluptate\",\n \"reprehenderit dolor esse\"\n ],\n \"msg\": \"sit dolore labore qui tempor\",\n \"type\": \"laboris eiusmod et consequat \"\n },\n {\n \"loc\": [\n \"id\",\n \"exercitation mollit\"\n ],\n \"msg\": \"Ut\",\n \"type\": \"officia deserunt eiusmod\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13782,7 +13922,7 @@ } }, { - "id": "7a6cd4e6-a2eb-499c-b569-aa50c84d92ff", + "id": "573bbc7d-0faf-4bdc-ad97-d9b0a772ea9d", "name": "Create Export", "request": { "name": "Create Export", @@ -13834,7 +13974,7 @@ }, "response": [ { - "id": "83d219d3-31fd-47dc-907d-3052e0df53f0", + "id": "ae087081-9352-4a70-8116-2effa4d63372", "name": "Successful Response", "originalRequest": { "url": { @@ -13891,7 +14031,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7cab39b8-bc2b-404a-b45d-fa7c4c4b4ebc", + "id": "56faeecf-d67d-4780-a187-7cb60294b738", "name": "Create Export Error", "originalRequest": { "url": { @@ -13954,7 +14094,7 @@ } }, { - "id": "fe612cc0-086a-4d37-bc6e-3318a482394b", + "id": "50d2b6f6-025a-470a-aef0-e0d091867439", "name": "Retrieve Export", "request": { "name": "Retrieve Export", @@ -14001,7 +14141,7 @@ }, "response": [ { - "id": "ac12e8fe-8b3c-4b8e-8d76-3fe933163fd0", + "id": "e31320dd-61c2-4f16-a26e-897aeb3e6f74", "name": "Returns an export object", "originalRequest": { "url": { @@ -14064,7 +14204,7 @@ "event": [] }, { - "id": "a96b9dfc-63cb-4dcb-bcfd-cdf5b82d8884", + "id": "f9568f90-cc52-4e36-a071-9b924f89463c", "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", @@ -14072,7 +14212,7 @@ }, "item": [ { - "id": "b02cb399-9b29-49b0-a092-9cfec53aab48", + "id": "3e4e6181-eae4-49c8-bca2-296693470aa7", "name": "Autocomplete", "request": { "name": "Autocomplete", @@ -14153,7 +14293,7 @@ }, "response": [ { - "id": "d9d60582-9fd2-4a60-90ba-c59d1400ec7d", + "id": "d1d04ffa-71ae-4065-a446-abd1b399412c", "name": "Returns a US autocompletion object.", "originalRequest": { "url": { @@ -14268,7 +14408,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ed39f199-c625-4596-b19d-979b3ab063fc", + "id": "9f6576f7-e921-45e6-85e7-5712b9927085", "name": "Error", "originalRequest": { "url": { @@ -14374,7 +14514,7 @@ "event": [] }, { - "id": "37968aa8-3928-4429-9291-5ccb111683ee", + "id": "00aba41c-4b5b-43a9-ad7e-4fdaf2429e77", "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
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.
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.
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.
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", @@ -14384,7 +14524,7 @@ "event": [] }, { - "id": "80c85295-9834-4465-a3f8-52d92e98dd5e", + "id": "7d2a40fa-ff2c-42cc-9214-896f05d6ef0c", "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", @@ -14392,7 +14532,7 @@ }, "item": [ { - "id": "6abfac88-861d-45a3-aff1-fe40695ff87c", + "id": "322aad4e-cf5a-4da0-976e-760824e0901a", "name": "Bulk Verify", "request": { "name": "Bulk Verify", @@ -14444,7 +14584,7 @@ }, "response": [ { - "id": "ca59011d-8161-470d-9633-ae36eedab11f", + "id": "41ca5e70-4eb3-4c5d-bf31-ff0644473767", "name": "Returns a list of US verification objects.", "originalRequest": { "url": { @@ -14529,7 +14669,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cbc50d0d-f21c-4172-9c8e-477126a8ae70", + "id": "b354ee62-f13c-4fc0-b55c-1b67b0e461ba", "name": "Error", "originalRequest": { "url": { @@ -14602,7 +14742,7 @@ } }, { - "id": "2619d506-0289-4820-ab0a-b0ab17df3c57", + "id": "73aa73e8-ae91-41f9-979d-41891f990ac4", "name": "Single Verify", "request": { "name": "Single Verify", @@ -14682,7 +14822,7 @@ }, "response": [ { - "id": "b4e3e74e-05e8-4953-81da-6823c4370ef1", + "id": "16ff46e8-9341-4218-b05e-e37aef5c0c37", "name": "Returns a US verification object.", "originalRequest": { "url": { @@ -14768,7 +14908,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7fc461f5-a1e0-4643-ad69-d72d22cc12e5", + "id": "52121442-9a10-442b-9ea5-48489fb14809", "name": "Error", "originalRequest": { "url": { @@ -14845,7 +14985,7 @@ "event": [] }, { - "id": "c6ccec88-f636-4495-8802-eade031ad172", + "id": "fe828b55-fc3f-4c8f-9c83-b086879fc0d7", "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 **2020-02-11**. 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. See\n[API Changelog](#tag/Versioning-and-Changelog) for a full list of breaking changes.\n\n### Example Request\n\n```bash\n curl https://api.lob.com/v1/addresses \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -H \"Lob-Version: 2020-02-11\"\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\n**2020-02-11**\n- renders merge_variables into HTML with syntax that supports objects, conditionals, and loops\n\n**2019-06-01**\n- changed pagination model of GET endpoints for postcards, letters, checks, addresses, bank accounts, templates, and template versions to a cursor-based model\n- offset parameter on these endpoints has been removed\n- previous_url and next_url response fields have been added\n\n**2018-06-05**\n- remove rate-limit headers\n\n**2018-03-30**\n- updated letter template which includes a white box behind the address block area to ensure deliverability\n\n**2018-03-01**\n- US verification deliverability value no_match deprecated and merged into undeliverable\n- US verification deliverability value deliverable_extra_secondary is split into deliverable_unnecessary_unit and deliverable_incorrect_unit\n- US verification deliverability value deliverable_missing_secondary renamed to deliverable_missing_unit\n- US verifications zip_code special values deprecated in favor of more comprehensive primary_line special values\n\n**2018-02-08**\n- enforce 50 character limit on the sum of address_line1 and address_line2 for check recipients\n\n**2017-11-08**\n- split extra_secondary_information into extra_secondary_designator and extra_secondary_number for /v1/us_verifications\n\n**2017-10-17**\n- remove support for the /v1/states endpoint\n- remove support for the /v1/countries endpoint\n- remove support for the message field from the POST /v1/postcards endpoint\n\n**2017-09-08**\n- renames input parameters and restructures response object for /v1/intl_verifications\n\n**2017-08-14**\n- automatically standardizes and corrects US addresses created via POST /v1/addresses. non-US addresses will be standardized into uppercase only.\n- automatically standardizes and corrects inline US addresses used in POST /v1/postcards, POST /v1/letters, and POST /v1/checks. non-US addresses will be standardized into uppercase only.\n- enforce 40 character limit on name and company for all addresses\n- enforce 64 character limit on address_line1 and address_line2 for US addresses\n\n**2017-06-16**\n- enforce 10,000 character limit on HTML strings\n- rename data parameter for all products to merge_variables\n\n**2017-05-17**\n- discontinues the /v1/verify endpoint - please use /v1/us_verifications or /v1/intl_verifications instead\n\n**2016-06-30** Sunsetted\n- unnest tracking object from postcard, letter, and check response objects\n\n**2016-05-02** Sunsetted\n- adds address_placement parameter to letters that defaults to top_first_page, template is no longer allowed\n\n**2016-03-21** Sunsetted\n- removes tracking numbers that do not provide any consumer-facing tracking information\n- removes link from tracking responses\n- requires account_type when creating a bank account\n\n**2016-01-19** Sunsetted\n- renames the count parameter to limit for all list endpoints\n- removes the next_url and previous_url from list responses\n\n**2015-12-22** Sunsetted\n- adds size parameter to postcards that defaults to 4x6, setting is no longer allowed\n\n**2015-11-23** Sunsetted\n- remove price from letters\n- remove pages from letters\n- remove price from postcards\n- renamed file parameter to check_bottom for checks\n\n**2015-11-06** Sunsetted\n- remove bank_address from bank_accounts\n- remove account_address from bank_accounts and add from to checks\n- remove price from checks\n\n**2015-10-21** Sunsetted\n- use the new HTML renderer for all products\n\n**2015-06-25** Sunsetted\n- remove the status field from all endpoints\n\n**2015-04-11** Sunsetted\n- errors on all endpoints are now single objects instead of arrays\n- full_bleed is no longer allowed for postcards, objects, and area mails - all products are now full_bleed by default\n- template is no longer allowed for postcards - all postcards must adhere to the template\n- name is no longer allowed for area mails, bank accounts, checks, jobs, objects, and postcards - it has been replaced by description\n- setting ID's 100 and 101 are no longer supported for objects - please use the Simple Letter Service instead\n- service is no longer supported for jobs\n- all boolean parameters now return true/false instead of 1/0\n- double_sided is no longer allowed for objects - all products are default double sided if more than one page is allowed\n- template is no longer allowed for objects\n\n**2014-12-18** Sunsetted\n- removed concept of packaging\n- signatory is now a required field when creating a bank account\n- bank_code is no longer an allowed field when creating a bank account\n- service_id parameter replaced by service parameter in /jobs\n- setting_id parameter replaced by setting parameter in /objects\n
back to top
\n", @@ -14855,7 +14995,7 @@ "event": [] }, { - "id": "06b13a50-42ed-4598-ab81-ae4d7875f75f", + "id": "02ee1323-70c7-47b5-a017-baead390b102", "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", @@ -14865,7 +15005,7 @@ "event": [] }, { - "id": "6c2192a2-a02a-487c-b51c-95f7428bc664", + "id": "301fbdbe-2b4c-4284-bdf5-28612e4b0795", "name": "Zip Lookups", "description": { "content": "Find a list of cities, states and associated information about a US ZIP code.
back to top
\n", @@ -14873,7 +15013,7 @@ }, "item": [ { - "id": "15daf885-88bf-4ca2-afe6-699431788ef7", + "id": "d26713b5-784e-4dbb-9edc-9957a4b138c0", "name": "Lookups", "request": { "name": "Lookups", @@ -14917,7 +15057,7 @@ }, "response": [ { - "id": "4b630ce4-e8fa-4c1b-b26c-3ccca50b6c73", + "id": "6ac102f8-d0bc-4072-bfd3-a35ee5dff4de", "name": "Returns a zip lookup object if a valid zip was provided.", "originalRequest": { "url": { @@ -14987,7 +15127,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4e572fdb-e895-4db6-8861-69edbbec7570", + "id": "f7c68350-f3ff-43cc-8fc5-64f0f12aca3c", "name": "Error", "originalRequest": { "url": { @@ -15070,7 +15210,7 @@ ] }, "info": { - "_postman_id": "b23e230d-b6c3-4181-8674-d2f8eef6f927", + "_postman_id": "980b261e-d8b8-4a20-9b16-0b9585692d95", "name": "Lob", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/resources/campaigns/models/campaign.yml b/resources/campaigns/models/campaign.yml index 91b87398..19fc5f5f 100644 --- a/resources/campaigns/models/campaign.yml +++ b/resources/campaigns/models/campaign.yml @@ -6,7 +6,6 @@ allOf: required: - id - - account_id - name - description - schedule_type @@ -22,10 +21,6 @@ allOf: id: $ref: "../attributes/cmp_id.yml" - account_id: - description: Account ID that this campaign is associated with. - type: string - is_draft: description: Whether or not the campaign is still a draft. type: boolean diff --git a/resources/campaigns/responses/all_campaigns.yml b/resources/campaigns/responses/all_campaigns.yml index cc5bac33..05bc7086 100644 --- a/resources/campaigns/responses/all_campaigns.yml +++ b/resources/campaigns/responses/all_campaigns.yml @@ -23,7 +23,6 @@ content: example: data: - id: cmp_e05ee61ff80764b - account_id: fa9ea650fc7b31a89f92 billing_group_id: bg_fe3079dcdd80e5ae name: My Campaign description: My Campaign's description diff --git a/resources/campaigns/responses/campaign.yml b/resources/campaigns/responses/campaign.yml index 3d9644d5..f55714f3 100644 --- a/resources/campaigns/responses/campaign.yml +++ b/resources/campaigns/responses/campaign.yml @@ -4,7 +4,6 @@ application/json: example: id: cmp_e05ee61ff80764b - account_id: fa9ea650fc7b31a89f92 billing_group_id: bg_fe3079dcdd80e5ae name: My Campaign description: My Campaign's description diff --git a/resources/creatives/models/campaign_item.yml b/resources/creatives/models/campaign_item.yml index 60f29e3d..262997cf 100644 --- a/resources/creatives/models/campaign_item.yml +++ b/resources/creatives/models/campaign_item.yml @@ -6,7 +6,6 @@ allOf: required: - id - - account_id - name - description - schedule_type @@ -22,10 +21,6 @@ allOf: id: $ref: "../../campaigns/attributes/cmp_id.yml" - account_id: - description: Account ID that this campaign is associated with. - type: string - is_draft: description: Whether or not the campaign is still a draft. type: boolean From d364d01aeeba9738a2109a998defd176c8a3e688 Mon Sep 17 00:00:00 2001 From: Aditi Ramaswamy <15935019+sudoku-lord@users.noreply.github.com> Date: Tue, 9 Aug 2022 11:37:19 -0700 Subject: [PATCH 4/5] Update resources/creatives/models/campaign_item.yml Co-authored-by: Jessica Ho <45194378+jho44@users.noreply.github.com> --- resources/creatives/models/campaign_item.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/resources/creatives/models/campaign_item.yml b/resources/creatives/models/campaign_item.yml index 262997cf..e7557f19 100644 --- a/resources/creatives/models/campaign_item.yml +++ b/resources/creatives/models/campaign_item.yml @@ -1,3 +1,4 @@ +# If you change something here, please make the same change to `resources/campaigns/models/campaign.yml`. allOf: - $ref: "../../../shared/models/lob_base.yml" - $ref: "../../campaigns/models/campaign_writable.yml" From 5baac49833c2d3a6b2c8d346ed220a923f8d16bf Mon Sep 17 00:00:00 2001 From: Aditi Ramaswamy <15935019+sudoku-lord@users.noreply.github.com> Date: Tue, 9 Aug 2022 11:37:58 -0700 Subject: [PATCH 5/5] Update resources/creatives/models/campaign_item.yml Co-authored-by: Jessica Ho <45194378+jho44@users.noreply.github.com> --- resources/creatives/models/campaign_item.yml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/resources/creatives/models/campaign_item.yml b/resources/creatives/models/campaign_item.yml index e7557f19..e1167338 100644 --- a/resources/creatives/models/campaign_item.yml +++ b/resources/creatives/models/campaign_item.yml @@ -1,6 +1,5 @@ # If you change something here, please make the same change to `resources/campaigns/models/campaign.yml`. allOf: - - $ref: "../../../shared/models/lob_base.yml" - $ref: "../../campaigns/models/campaign_writable.yml" - type: object @@ -37,3 +36,12 @@ allOf: enum: - campaign default: campaign + + date_created: + $ref: "../../../shared/attributes/timestamps.yml#/date_created" + + date_modified: + $ref: "../../../shared/attributes/timestamps.yml#/date_modified" + + deleted: + $ref: "../../../shared/attributes/deleted.yml"