{
"item": [
{
"id": "e8d3d883-2a3d-483b-999e-e9dab2cb52df",
"name": "Addresses",
"description": {
"content": "To add an address to your address book, you create a new address object. You can retrieve and delete individual\naddresses as well as get a list of addresses. Addresses are identified by a unique random ID.\n\n",
"type": "text/plain"
},
"item": [
{
"id": "c26a671f-c45f-4565-bae4-e6f3565937fb",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your addresses. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "before",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "after",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "date_created[non_94]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[magna_2ca]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[officia_3]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "20b7b348-8c68-409d-8605-19bdc8c1bcf0",
"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": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"adr_e68217bd744d65c8\",\n \"description\": \"Harry - Office\",\n \"name\": \"HARRY ZHANG\",\n \"company\": \"LOB\",\n \"phone\": \"5555555555\",\n \"email\": \"harry@lob.com\",\n \"address_line1\": \"210 KING ST STE 6100\",\n \"address_line2\": null,\n \"address_city\": \"SAN FRANCISCO\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94107-1741\",\n \"address_country\": \"UNITED STATES\",\n \"metadata\": {},\n \"date_created\": \"2019-08-12T00:16:00.361Z\",\n \"date_modified\": \"2019-08-12T00:16:00.361Z\",\n \"object\": \"address\"\n },\n {\n \"id\": \"adr_asdi2y3riuasasoi\",\n \"description\": \"Harry - Office\",\n \"name\": \"Harry Zhang\",\n \"company\": \"Lob\",\n \"phone\": \"5555555555\",\n \"email\": \"harry@lob.com\",\n \"metadata\": {},\n \"address_line1\": \"370 WATER ST\",\n \"address_line2\": \"\",\n \"address_city\": \"SUMMERSIDE\",\n \"address_state\": \"PRINCE EDWARD ISLAND\",\n \"address_zip\": \"C1N 1C4\",\n \"address_country\": \"CANADA\",\n \"date_created\": \"2019-09-20T00:14:00.361Z\",\n \"date_modified\": \"2019-09-20T00:14:00.361Z\",\n \"object\": \"address\"\n }\n ],\n \"object\": \"list\",\n \"next_url\": \"https://api.lob.com/v1/addresses?limit=2&after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wN1QyMTo1OTo0Ni43NjRaIiwiaWRPZmZzZXQiOiJhZHJfODMwYmYwZWFiZGFhYTQwOSJ9\",\n \"previous_url\": null,\n \"count\": 2\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "239545d9-682b-467c-9de0-548a7b5ea0ed",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"address not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "e88a26fd-be67-4a11-83d3-a003fdef4016",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new address given information",
"type": "text/plain"
},
"url": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "value",
"value": ""
},
{
"disabled": false,
"key": "value",
"value": ""
},
{
"disabled": false,
"key": "value",
"value": ""
},
{
"disabled": false,
"key": "value",
"value": ""
},
{
"disabled": false,
"key": "value",
"value": ""
}
]
}
},
"response": [
{
"id": "97fa0d2a-837a-4804-9901-dfef4302c805",
"name": "Echos the writable fields of a newly created address object.",
"originalRequest": {
"url": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Harry - Office"
},
{
"disabled": false,
"key": "name",
"value": "Harry Zhang"
},
{
"disabled": false,
"key": "company",
"value": "Lob"
},
{
"disabled": false,
"key": "email",
"value": "harry@lob.com"
},
{
"disabled": false,
"key": "phone",
"value": "5555555555"
},
{
"disabled": false,
"key": "address_line1",
"value": "210 King St"
},
{
"disabled": false,
"key": "address_line2",
"value": "# 6100"
},
{
"disabled": false,
"key": "address_city",
"value": "San Francisco"
},
{
"disabled": false,
"key": "address_state",
"value": "CA"
},
{
"disabled": false,
"key": "address_zip",
"value": "94107"
},
{
"disabled": false,
"key": "address_country",
"value": "US"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"disabled": false,
"description": "The rate limit for a given endpoint.",
"key": "ratelimit-limit",
"value": "150"
},
{
"disabled": false,
"description": "The number of requests remaining in the current window.",
"key": "ratelimit-remaining",
"value": "100"
},
{
"disabled": false,
"description": "The time at which the rate limit window resets in UTC epoch seconds\n",
"key": "ratelimit-reset",
"value": "1528749846"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"adr_d3489cd64c791ab5\",\n \"description\": \"Harry - Office\",\n \"name\": \"HARRY ZHANG\",\n \"company\": \"LOB\",\n \"phone\": \"5555555555\",\n \"email\": \"harry@lob.com\",\n \"address_line1\": \"210 KING ST STE 6100\",\n \"address_city\": \"SAN FRANCISCO\",\n \"address_state\": \"CA\",\n \"address_zip\": \"94107\",\n \"address_country\": \"UNITED STATES\",\n \"metadata\": {},\n \"date_created\": \"2017-09-05T17:47:53.767Z\",\n \"date_modified\": \"2017-09-05T17:47:53.767Z\",\n \"object\": \"address\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fefb4965-9622-4be8-bc53-77b8a1f62d02",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"addresses"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Harry - Office"
},
{
"disabled": false,
"key": "name",
"value": "Harry Zhang"
},
{
"disabled": false,
"key": "company",
"value": "Lob"
},
{
"disabled": false,
"key": "email",
"value": "harry@lob.com"
},
{
"disabled": false,
"key": "phone",
"value": "5555555555"
},
{
"disabled": false,
"key": "address_line1",
"value": "210 King St"
},
{
"disabled": false,
"key": "address_line2",
"value": "# 6100"
},
{
"disabled": false,
"key": "address_city",
"value": "San Francisco"
},
{
"disabled": false,
"key": "address_state",
"value": "CA"
},
{
"disabled": false,
"key": "address_zip",
"value": "94107"
},
{
"disabled": false,
"key": "address_country",
"value": "US"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"address not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "f4c06bde-2386-4c45-87c2-b8475fc6f9d2",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the details of an existing address. You need only supply the unique identifier that was returned upon address creation.",
"type": "text/plain"
},
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "121ae5b5-be2c-4007-962b-c40b7b7f5e6b",
"name": "Returns an address object if a valid identifier was provided.",
"originalRequest": {
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"date_created\": {\n \"value\": \"\"\n },\n \"date_modified\": {\n \"value\": \"\"\n },\n \"object\": {\n \"value\": \"\"\n },\n \"deleted\": {\n \"value\": \"\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b0dca524-088e-400a-b606-98db819906f5",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"address not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "6cad3316-cc81-41ae-afdf-46d252f21b1c",
"name": "Delete",
"request": {
"name": "Delete",
"description": {
"content": "Deletes the details of an existing address. You need only supply the unique identifier that was returned upon address creation.",
"type": "text/plain"
},
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": null
},
"response": [
{
"id": "d28466d9-772a-47b2-8d2c-16ca62653ca6",
"name": "Deleted",
"originalRequest": {
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"adr_123456789\",\n \"deleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "945acbab-13f7-449e-8abe-a7fc8b04432b",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"addresses",
":adr_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "adr_id",
"description": "(Required) id of the address"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"address not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
}
],
"event": []
},
{
"id": "edc55347-cec0-441f-a026-590b9f350bde",
"name": "Authentication",
"description": {
"content": "Requests made to the API are protected with HTTP Basic authentication.\nIn order to properly authenticate with the API you must use your API key as the username\nwhile leaving the password blank. Requests not properly authenticated will return a `401`\n[error code](#tag/Errors). You can find your account's API keys\nin your Dashboard Settings.\n### Example Request\ncurl uses the -u flag to pass basic auth credentials (adding a colon after your API key will prevent it from asking you for a\npassword). One of our test API keys has been filled into all the examples on the page, so you can test out any example right away.\n```bash\ncurl https://api.lob.com/v1/addresses \\\n -u test_0dc8dXXXXXXXXXXXXXXXXXXXXXX5b0cc:\n```\n## API Keys\n Lob authenticates your API requests using your account's API keys.\n If you do not include your key when making an API request, or use\n one that is incorrect or outdated, Lob returns an error with a `401`\n HTTP response code. You can find all API keys in your dashboard\n under Settings.\n There are two types of API keys: *secret* and *publishable*.\n - **Secret API keys** should be kept confidential and only stored on your own servers.\n Your account's secret API key can perform any API request to Lob without restriction.\n - **Publishable API keys** are limited to US verifications, international verifications,\n and US autocomplete requests. For maximum security, we encourage you to not expose your \n secret key. You can include the publishable keys in JavaScript code or in an Android or iPhone app\n without exposing your Lob Print and Mail account services or your secret key. Publishable keys are always\n prefixed with `[environment]_pub`.\n Every type comes with a pair of keys: one for the testing environment and one for the\n live environment. We recommend reading [Test and Live Environments](#tag/Test-and-Live-Environments)\n for more information.\n
\n \n",
"type": "text/plain"
},
"item": [],
"event": []
},
{
"id": "cb7209d8-571b-41c4-b18b-6f94a8106a3c",
"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\n",
"type": "text/plain"
},
"item": [
{
"id": "1f7a0861-13b6-47cf-9b4f-09a5a4635c75",
"name": "Verify",
"request": {
"name": "Verify",
"description": {
"content": "Verify a bank account in order to create a check.\n\nCheck the `microdeposit_type` field returned by `GET /v1/bank_accounts/:id` to determine which parameter to submit:\n- `amounts` — provide the two microdeposit amounts (in cents) that appeared\n in the bank account statement.\n\n- `descriptor_code` — provide the 6-character code (beginning with `SM`)\n from the bank statement descriptor of the single $0.01 microdeposit.\n\n\nSubmitting the wrong parameter type for the account's `microdeposit_type` will return an error.",
"type": "text/plain"
},
"url": {
"path": [
"bank_accounts",
":bank_id",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account to be verified"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "amounts",
"value": ""
},
{
"disabled": false,
"key": "amounts",
"value": ""
}
]
}
},
"response": [
{
"id": "2d74207e-4f7d-4017-b007-b06d04701da6",
"name": "Returns a bank_account object",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account to be verified"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "amounts",
"value": "25"
},
{
"disabled": false,
"key": "amounts",
"value": "63"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"disabled": false,
"description": "The rate limit for a given endpoint.",
"key": "ratelimit-limit",
"value": "150"
},
{
"disabled": false,
"description": "The number of requests remaining in the current window.",
"key": "ratelimit-remaining",
"value": "100"
},
{
"disabled": false,
"description": "The time at which the rate limit window resets in UTC epoch seconds\n",
"key": "ratelimit-reset",
"value": "1528749846"
},
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "7d74c44f-b253-4b45-8c16-5636dae90570",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id",
"verify"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account to be verified"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "amounts",
"value": "25"
},
{
"disabled": false,
"key": "amounts",
"value": "63"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"routing_number is required\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "323e77c8-68b4-404a-b292-6bd92483a421",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation.",
"type": "text/plain"
},
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "0b278f4f-6208-4c6a-acda-681c9de8c88a",
"name": "Returns a bank account object",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "6cf67100-efbb-4322-8535-78f1d49d3cf5",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"routing_number is required\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "f2018f88-eda6-448c-8027-3e2a372cd4b8",
"name": "Delete",
"request": {
"name": "Delete",
"description": {
"content": "Permanently deletes a bank account. It cannot be undone.",
"type": "text/plain"
},
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": null
},
"response": [
{
"id": "cc65cca0-47dd-4099-9b0b-34d3187e1d40",
"name": "Deleted",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"bank_123456789\",\n \"deleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ed3bebd8-4954-4d14-a4d4-e4bf70666ce1",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"bank_accounts",
":bank_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bank_id",
"description": "(Required) id of the bank account"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"routing_number is required\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "905fa07f-5446-4c3a-a7e2-734a854b32e7",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "before",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "after",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "date_created[non_94]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[magna_2ca]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[officia_3]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "f8f6a396-4e59-4d31-97ae-5b243476f83a",
"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": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"bank_0e3fb07eba0b35b\",\n \"signature_url\": \"https://lob-assets.com/letters/asd_asdfghjklqwertyu.pdf?version=45&expires=1234567890&signature=a\",\n \"description\": \"Example bank account\",\n \"metadata\": {},\n \"routing_number\": \"122100024\",\n \"account_number\": \"1234564789\",\n \"account_type\": \"company\",\n \"signatory\": \"John Doe\",\n \"bank_name\": \"JPMORGAN CHASE BANK, NA\",\n \"verified\": true,\n \"date_created\": \"2019-03-30T13:13:22.200Z\",\n \"date_modified\": \"2019-03-30T13:13:23.385Z\",\n \"object\": \"bank_account\"\n },\n {\n \"id\": \"bank_eba93f7de3c02d9\",\n \"description\": \"Example bank account\",\n \"metadata\": {},\n \"routing_number\": \"122100024\",\n \"account_number\": \"1234564789\",\n \"account_type\": \"company\",\n \"signatory\": \"John Doe\",\n \"bank_name\": \"JPMORGAN CHASE BANK, NA\",\n \"verified\": true,\n \"date_created\": \"2019-03-30T13:11:06.809Z\",\n \"date_modified\": \"2019-03-30T13:11:07.872Z\",\n \"object\": \"bank_account\"\n }\n ],\n \"object\": \"list\",\n \"next_url\": \"https://api.lob.com/v1/bank_accounts?limit=2&after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wMy0zMFQxMzoxMTowNi44MDlaIiwiaWRPZmZzZXQiOiJiYW5rX2ViYTkzZjdkZTNjMDJkOSJ9\",\n \"previous_url\": null,\n \"count\": 2\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "71d2ebe1-3829-42c0-a600-435f407d4939",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"routing_number is required\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "626fac9f-c964-4758-83ab-7983fcb110f7",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\".",
"type": "text/plain"
},
"url": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "routing_number",
"value": "",
"description": "(Required) Must be a valid US routing number."
},
{
"disabled": false,
"key": "account_number",
"value": "",
"description": "(Required) "
},
{
"disabled": false,
"key": "account_type",
"value": "",
"description": "(Required) The type of entity that holds the account."
},
{
"disabled": false,
"key": "signatory",
"value": "",
"description": "(Required) The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the Dashboard."
},
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "check_template",
"value": "",
"description": "The check template used for printing. The defualt value is `common`. If you bank with JP Morgan Chase and wish to use Positive Pay use the `jpm` template. `jpm` requires additional information to be provided."
},
{
"disabled": false,
"key": "fractional_routing_number",
"value": "",
"description": "The fractional routing number for your home bank account. Required for the `jpm` check template only. Please contact a bank representative if you do not know the fractional routing number associated with your home bank institution."
},
{
"disabled": false,
"key": "city",
"value": "",
"description": "The city associated with your home bank account. Required for the `jpm` check template only. Please contact a bank representative if you do not know the city associated with your home bank institution."
},
{
"disabled": false,
"key": "state",
"value": "",
"description": "The state associated with your home bank account. Required for the `jpm` check template only. Please contact a bank representative if you do not know the state associated with your home bank institution."
},
{
"disabled": false,
"key": "zipcode",
"value": "",
"description": "The zipcode associated with your home bank account. Required for the `jpm` check template only. Please contact a bank representative if you do not know the zipcode associated with your home bank institution."
}
]
}
},
"response": [
{
"id": "2fd761c8-4e83-4855-b309-888ba0de8abe",
"name": "Returns a bank_account object",
"originalRequest": {
"url": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test Bank Account"
},
{
"disabled": false,
"description": {
"content": "(Required) Must be a valid US routing number.",
"type": "text/plain"
},
"key": "routing_number",
"value": "322271627"
},
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"key": "account_number",
"value": "123456789"
},
{
"disabled": false,
"description": {
"content": "(Required) The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the Dashboard.",
"type": "text/plain"
},
"key": "signatory",
"value": "Jane Doe"
},
{
"disabled": false,
"description": {
"content": "(Required) The type of entity that holds the account.",
"type": "text/plain"
},
"key": "account_type",
"value": "individual"
},
{
"disabled": false,
"key": "metadata[spiffy]",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"disabled": false,
"description": "The rate limit for a given endpoint.",
"key": "ratelimit-limit",
"value": "150"
},
{
"disabled": false,
"description": "The number of requests remaining in the current window.",
"key": "ratelimit-remaining",
"value": "100"
},
{
"disabled": false,
"description": "The time at which the rate limit window resets in UTC epoch seconds\n",
"key": "ratelimit-reset",
"value": "1528749846"
},
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "7e697ad4-6b3d-42f4-8459-c7577858448a",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"bank_accounts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test Bank Account"
},
{
"disabled": false,
"description": {
"content": "(Required) Must be a valid US routing number.",
"type": "text/plain"
},
"key": "routing_number",
"value": "322271627"
},
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"key": "account_number",
"value": "123456789"
},
{
"disabled": false,
"description": {
"content": "(Required) The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the Dashboard.",
"type": "text/plain"
},
"key": "signatory",
"value": "Jane Doe"
},
{
"disabled": false,
"description": {
"content": "(Required) The type of entity that holds the account.",
"type": "text/plain"
},
"key": "account_type",
"value": "individual"
},
{
"disabled": false,
"key": "metadata[spiffy]",
"value": "true"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"routing_number is required\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"id": "69efef30-044c-48ec-92b3-3c743ef3952c",
"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\n",
"type": "text/plain"
},
"item": [],
"event": []
},
{
"id": "d04e9218-3bd8-44ae-9c74-b8f1b6515bca",
"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\n",
"type": "text/plain"
},
"item": [
{
"id": "dd28fa4e-157f-4212-8e50-40c400470810",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation.",
"type": "text/plain"
},
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "b6b38495-63cf-4697-8fd9-1e277fd09cc9",
"name": "Returns a billing_group object.",
"originalRequest": {
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "91f0c718-3cdc-4164-aafa-e88175c14b79",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"billing_group not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "fd03ca28-d53c-411e-b415-45f77ba39c61",
"name": "Update",
"request": {
"name": "Update",
"description": {
"content": "Updates all editable attributes of the billing_group with the given id.",
"type": "text/plain"
},
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "name",
"value": ""
}
]
}
},
"response": [
{
"id": "d776045b-7dc1-4c9a-b4dc-fecb6941c8ae",
"name": "Returns a billing group object",
"originalRequest": {
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": "Marketing Dept"
},
{
"disabled": false,
"key": "description",
"value": "Usage group used for the Marketing Dept resource sends"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"disabled": false,
"description": "The rate limit for a given endpoint.",
"key": "ratelimit-limit",
"value": "150"
},
{
"disabled": false,
"description": "The number of requests remaining in the current window.",
"key": "ratelimit-remaining",
"value": "100"
},
{
"disabled": false,
"description": "The time at which the rate limit window resets in UTC epoch seconds\n",
"key": "ratelimit-reset",
"value": "1528749846"
},
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "6630c013-1d21-46f2-af14-52a608743617",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"billing_groups",
":bg_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "bg_id",
"description": "(Required) id of the billing_group"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": "Marketing Dept"
},
{
"disabled": false,
"key": "description",
"value": "Usage group used for the Marketing Dept resource sends"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "9acb3299-203e-460a-9eca-6730552b5bed",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "offset",
"value": "0",
"description": "An integer that designates the offset at which to begin returning results. Defaults to 0."
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "date_created[non_94]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[magna_2ca]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created[officia_3]",
"value": "",
"description": "Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_modified[non_94]",
"value": "",
"description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_modified[magna_2ca]",
"value": "",
"description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_modified[officia_3]",
"value": "",
"description": "Filter by date modified. Accepted formats are ISO-8601 date or datetime, e.g. `{ \"gt\": \"2012-01-01\", \"lt\": \"2012-01-31T12:34:56Z\" }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤."
},
{
"disabled": false,
"key": "date_created",
"value": "",
"description": "Sorts items by ascending or descending dates. Use either `date_created` or `date_modified`, not both.\n"
},
{
"disabled": false,
"key": "date_modified",
"value": "",
"description": "Sorts items by ascending or descending dates. Use either `date_created` or `date_modified`, not both.\n"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "6b15b45c-da7c-46c1-8b25-a3ed1baccc2f",
"name": "Returns a list of billing_groups.",
"originalRequest": {
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
},
{
"key": "date_modified[nulla_2d]",
"value": ""
},
{
"key": "date_created",
"value": ""
},
{
"key": "date_modified",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "1862d3da-fe6a-4176-a797-7a9b2b0fbb05",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "date_created[nulla_2d]",
"value": ""
},
{
"key": "date_modified[nulla_2d]",
"value": ""
},
{
"key": "date_created",
"value": ""
},
{
"key": "date_modified",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"billing_group not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "df157877-9ec9-449b-984f-62ab2b9381af",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new billing_group with the provided properties.",
"type": "text/plain"
},
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "name",
"value": ""
}
]
}
},
"response": [
{
"id": "89e9cba1-cdaa-4cce-8c86-7ec267da3cc0",
"name": "Returns a billing group object",
"originalRequest": {
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": "Marketing Dept"
},
{
"disabled": false,
"key": "description",
"value": "Usage group used for the Marketing Dept resource sends"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"disabled": false,
"description": "The rate limit for a given endpoint.",
"key": "ratelimit-limit",
"value": "150"
},
{
"disabled": false,
"description": "The number of requests remaining in the current window.",
"key": "ratelimit-remaining",
"value": "100"
},
{
"disabled": false,
"description": "The time at which the rate limit window resets in UTC epoch seconds\n",
"key": "ratelimit-reset",
"value": "1528749846"
},
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "af93a90f-48bd-46ee-bc6a-850ac4f9876b",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"billing_groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": "Marketing Dept"
},
{
"disabled": false,
"key": "description",
"value": "Usage group used for the Marketing Dept resource sends"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"id": "69f6d78a-3714-400d-97e8-36f240102071",
"name": "Buckslip Orders",
"description": {
"content": "The Buckslip Orders endpoint allows you to easily create buckslip orders for existing buckslips.\nThe API provides endpoints for creating buckslip orders and listing buckslip orders for a given buckslip.\n\n",
"type": "text/plain"
},
"item": [
{
"id": "e757ca20-077c-437f-92f4-2a8b85014a0e",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the buckslip orders associated with the given buckslip id.",
"type": "text/plain"
},
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "offset",
"value": "0",
"description": "An integer that designates the offset at which to begin returning results. Defaults to 0."
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "3b3f990c-e52f-4095-82fc-359a80811be4",
"name": "Returns the buckslip orders associated with the given buckslip id",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "318b27ad-5035-42aa-ac16-6afb59350475",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"buckslip not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "1da9566a-aec3-4baa-a90e-9301118c4544",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new buckslip order given information",
"type": "text/plain"
},
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "quantity",
"value": "",
"description": "(Required) The quantity of buckslips in the order (minimum 5,000)."
}
]
}
},
"response": [
{
"id": "06bd2010-bf65-4eeb-8e95-388a0ca86cd1",
"name": "Buckslip order created successfully",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) The quantity of buckslips in the order (minimum 5,000).",
"type": "text/plain"
},
"key": "quantity",
"value": "10000"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "76fc2314-2bff-442e-aecf-0e5f372fa936",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) The ID of the buckslip to which the buckslip orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) The quantity of buckslips in the order (minimum 5,000).",
"type": "text/plain"
},
"key": "quantity",
"value": "10000"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"id": "4af77dc0-6745-450e-820d-10d7a40af2c6",
"name": "Buckslips",
"description": {
"content": "The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters.\nThe API provides endpoints for creating buckslips, retrieving individual buckslips, creating buckslip orders, and retrieving a list of buckslips.\n\n",
"type": "text/plain"
},
"item": [
{
"id": "b5f58b28-0466-4068-ae37-572d6d65dc66",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your buckslips. The buckslips are returned sorted by creation date, with the most recently created buckslips appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "before",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "after",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "01677742-ca5c-418b-8a5b-d95709cb6dec",
"name": "Returns a list of buckslip objects",
"originalRequest": {
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "5799ae1e-46b7-49a5-a33e-49b0e6ad05b2",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "ab543263-2112-489c-aa6b-f7e88b957749",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new buckslip given information",
"type": "text/plain"
},
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "front",
"value": ""
},
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "size",
"value": "8.75x3.75"
},
{
"disabled": false,
"key": "back",
"value": ""
}
]
}
},
"response": [
{
"id": "d00621db-5540-45e7-8300-9697a5d8ba7b",
"name": "Buckslip created successfully",
"originalRequest": {
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test buckslip"
},
{
"disabled": false,
"key": "front",
"value": "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/buckslip.pdf"
},
{
"disabled": false,
"key": "back",
"value": "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/buckslip.pdf"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "9202479c-c892-48c2-bd98-9c33557f6001",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test buckslip"
},
{
"disabled": false,
"key": "front",
"value": "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/buckslip.pdf"
},
{
"disabled": false,
"key": "back",
"value": "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/buckslip.pdf"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "572ec250-3cc5-4f9c-a986-68ea4a60ee17",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the details of an existing buckslip. You need only supply the unique customer identifier that was returned upon buckslip creation.",
"type": "text/plain"
},
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "c4fc4f28-8d6d-42c7-862b-905bebb2b8af",
"name": "Returns a buckslip object",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "65127edc-cdbf-4d6f-95a4-9e6a76e2c7db",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "8243e3ad-c144-4cff-b807-a1fc00aa39ac",
"name": "Update",
"request": {
"name": "Update",
"description": {
"content": "Update the details of an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.",
"type": "text/plain"
},
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "PATCH",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "auto_reorder",
"value": "",
"description": "Allows for auto reordering"
},
{
"disabled": false,
"key": "reorder_quantity",
"value": "",
"description": "The quantity of items to be reordered (only required when auto_reorder is true)."
}
]
}
},
"response": [
{
"id": "751a5025-f26f-412e-ac2d-4680e7888364",
"name": "Returns a buckslip object",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "PATCH",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test buckslip"
},
{
"disabled": false,
"description": {
"content": "Allows for auto reordering",
"type": "text/plain"
},
"key": "auto_reorder",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "58a772d5-4704-477c-baa5-eaa94a850d28",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "PATCH",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test buckslip"
},
{
"disabled": false,
"description": {
"content": "Allows for auto reordering",
"type": "text/plain"
},
"key": "auto_reorder",
"value": "true"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "d9524417-e501-44ce-8668-99d6c96f1cb6",
"name": "Delete",
"request": {
"name": "Delete",
"description": {
"content": "Delete an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.",
"type": "text/plain"
},
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": null
},
"response": [
{
"id": "79a74e23-e141-4ce8-8445-a3708b08ba6b",
"name": "Deleted the buckslip",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"buckslip_123456789\",\n \"deleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "5365d1fa-48a0-417e-9150-431696d29764",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"buckslips",
":buckslip_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "buckslip_id",
"description": "(Required) id of the buckslip"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid\",\n \"message\": \"message about incorrect parameter\",\n \"status_code\": 422\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
}
],
"event": []
},
{
"id": "e3abffd4-10c8-4b3b-be0e-dca40aa2847f",
"name": "Bulk Intl Verifications",
"description": {
"content": "Verify a list of non-US addresses.\n\n",
"type": "text/plain"
},
"item": [],
"event": []
},
{
"id": "23f3861d-f778-403a-a178-a00234fbe82f",
"name": "Bulk US Verifications",
"description": {
"content": "Verify a list of US addresses.\n\n",
"type": "text/plain"
},
"item": [],
"event": []
},
{
"id": "28c86338-7726-4baf-9ce2-165d0a92bd14",
"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",
"type": "text/plain"
},
"item": [
{
"id": "c9fbbef6-b69c-46e7-a2d0-8fba7ff2d35e",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"campaigns"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "before",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "after",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "aa3e8ca2-2d38-4712-a403-1a4f325710a1",
"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": {
"path": [
"campaigns"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"cmp_e05ee61ff80764b\",\n \"billing_group_id\": \"bg_fe3079dcdd80e5ae\",\n \"name\": \"My Campaign\",\n \"description\": \"My Campaign's description\",\n \"schedule_type\": \"immediate\",\n \"send_date\": null,\n \"target_delivery_date\": null,\n \"cancel_window_campaign_minutes\": 60,\n \"metadata\": {},\n \"use_type\": \"marketing\",\n \"is_draft\": true,\n \"deleted\": false,\n \"creatives\": [],\n \"uploads\": [],\n \"auto_cancel_if_ncoa\": false,\n \"date_created\": \"2017-09-05T17:47:53.767Z\",\n \"date_modified\": \"2017-09-05T17:47:53.767Z\",\n \"object\": \"campaign\"\n }\n ],\n \"object\": \"list\",\n \"previous_url\": null,\n \"next_url\": null,\n \"count\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "08cc6b66-b74c-4e38-a365-e4a96f2d15fd",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new campaign with the provided properties. See how to launch your first campaign [here](https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/launch-your-first-campaign).",
"type": "text/plain"
},
"url": {
"path": [
"campaigns"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"disabled": false,
"description": "* `native` - Translate response to the native language of the country in the request\n* `match` - match the response to the language in the request\n\nDefault response is in English.\n",
"key": "x-lang-output",
"value": ""
},
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": "",
"description": "(Required) Name of the campaign."
},
{
"disabled": false,
"key": "schedule_type",
"value": "",
"description": "(Required) "
},
{
"disabled": false,
"key": "use_type",
"value": "",
"description": "(Required) "
},
{
"disabled": false,
"key": "billing_group_id",
"value": "",
"description": "Unique identifier prefixed with `bg_`."
},
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "target_delivery_date",
"value": "",
"description": "If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign."
},
{
"disabled": false,
"key": "send_date",
"value": "",
"description": "If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign."
},
{
"disabled": false,
"key": "cancel_window_campaign_minutes",
"value": "",
"description": "A window, in minutes, within which the campaign can be canceled."
},
{
"disabled": false,
"key": "metadata",
"value": "`ZqBZ4Tjf]Ri'5|yN[7e +%Hpyt~p9;-~kBhfku4U:=|t,cT>#$jM^f[TSQ4Jn?W5a^zK2WA_=_z9U&=&pT_]Rw2?Zv03FST $]3Y5TP:Gin#4(SzwI%}_r{X(]mNzcUmW(.]l`w{MZ![2uT|$N:A^'(:ykNUG,5zyS0pINQA>;mzu2&d?'aa3D*[JV ]#HI*sv,+ugwDl.d[e!r~~slVh-,}xkEXhvp=3T%7[D3,NI:kyrbq@%>HY!MwreP-wQMjZG># x(A$VWvr*E"
},
{
"disabled": false,
"key": "auto_cancel_if_ncoa",
"value": "",
"description": "Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA."
},
{
"disabled": false,
"key": "print_speed",
"value": "core"
}
]
}
},
"response": [
{
"id": "52e982ab-afdc-4b3a-9e8f-c65c8971f6d8",
"name": "Campaign created successfully",
"originalRequest": {
"url": {
"path": [
"campaigns"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
},
{
"disabled": false,
"description": "* `native` - Translate response to the native language of the country in the request\n* `match` - match the response to the language in the request\n\nDefault response is in English.\n",
"key": "x-lang-output",
"value": ""
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) Name of the campaign.",
"type": "text/plain"
},
"key": "name",
"value": "My Demo Campaign"
},
{
"disabled": false,
"key": "description",
"value": "My Campaign's description"
},
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"key": "schedule_type",
"value": "immediate"
},
{
"disabled": false,
"key": "print_speed",
"value": "core"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "c7b34923-12f9-48dc-9208-9a3c16dd89cd",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"campaigns"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
},
{
"disabled": false,
"description": "* `native` - Translate response to the native language of the country in the request\n* `match` - match the response to the language in the request\n\nDefault response is in English.\n",
"key": "x-lang-output",
"value": ""
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) Name of the campaign.",
"type": "text/plain"
},
"key": "name",
"value": "My Demo Campaign"
},
{
"disabled": false,
"key": "description",
"value": "My Campaign's description"
},
{
"disabled": false,
"description": {
"content": "(Required) ",
"type": "text/plain"
},
"key": "schedule_type",
"value": "immediate"
},
{
"disabled": false,
"key": "print_speed",
"value": "core"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"campaign not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "70559ef9-4846-4092-87e4-117049e330b3",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.",
"type": "text/plain"
},
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "a2527683-bb68-4a6a-a77b-017997250776",
"name": "Returns a campaign object",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "6c9ea91c-c603-44b4-9e24-af1fe0afbfbd",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"campaign not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "ef562233-ce5d-4634-940d-8602c36778d4",
"name": "Update",
"request": {
"name": "Update",
"description": {
"content": "Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation.",
"type": "text/plain"
},
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "PATCH",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "name",
"value": ""
},
{
"disabled": false,
"key": "description",
"value": ""
},
{
"disabled": false,
"key": "schedule_type",
"value": ""
},
{
"disabled": false,
"key": "target_delivery_date",
"value": "",
"description": "If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign."
},
{
"disabled": false,
"key": "send_date",
"value": "",
"description": "If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign."
},
{
"disabled": false,
"key": "cancel_window_campaign_minutes",
"value": "",
"description": "A window, in minutes, within which the campaign can be canceled."
},
{
"disabled": false,
"key": "metadata",
"value": "<[v_kxw,!3m]6w3T qG!XnO# SlmNA,13|ia~GP-ABNMqv!9J`gM!s|:yLh%DT?4W&YEBDhYpuxHMM!f&PgI:mu{sv|E(&/Y.tQ`L"
},
{
"disabled": false,
"key": "is_draft",
"value": "",
"description": "Whether or not the campaign is still a draft. Can either be excluded or `false`."
},
{
"disabled": false,
"key": "use_type",
"value": ""
},
{
"disabled": false,
"key": "auto_cancel_if_ncoa",
"value": "",
"description": "Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA."
}
]
}
},
"response": [
{
"id": "9bd01274-1dd1-4d86-b0d4-5b99d7aa245e",
"name": "Returns a campaign object",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "PATCH",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test campaign"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "d3b0b773-7289-4111-bae0-fc42f00aeebe",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "PATCH",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "description",
"value": "Test campaign"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"campaign not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "2c3013aa-1d19-4e05-b787-773a343a1a13",
"name": "Delete",
"request": {
"name": "Delete",
"description": {
"content": "Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's `send_date` matches its associated mail pieces' `send_date`s.",
"type": "text/plain"
},
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": null
},
"response": [
{
"id": "ed82b0cd-59f7-4165-be27-2897abe584ee",
"name": "Deleted the campaign.",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"cmp_e05ee61ff80764b\",\n \"deleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "042effd3-ef3f-408e-bda8-02b8ea27bbab",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "DELETE",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"campaign not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "539258a5-048c-453d-ae24-b3befb76e9a7",
"name": "Send Campaign",
"request": {
"name": "Send Campaign",
"description": {
"content": "Sends a campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.",
"type": "text/plain"
},
"url": {
"path": [
"campaigns",
":cmp_id",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null
},
"response": [
{
"id": "e6b77639-10f2-4573-88d5-63de44fa560e",
"name": "Returns a campaign object",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "76ebf87f-0bf6-43f2-8e14-e5748a5dac28",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"campaigns",
":cmp_id",
"send"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "cmp_id",
"description": "(Required) id of the campaign"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"campaign not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
}
],
"event": []
},
{
"id": "1428fee2-6109-4641-8196-c4e3f3f41ca9",
"name": "Card Orders",
"description": {
"content": "The card orders endpoint allows you to easily create card orders for existing cards.\nThe API provides endpoints for creating card orders and listing card orders for a given card.\n\n",
"type": "text/plain"
},
"item": [
{
"id": "cc897714-6459-4ca5-a20c-4a47a9dc8ba4",
"name": "Retrieve",
"request": {
"name": "Retrieve",
"description": {
"content": "Retrieves the card orders associated with the given card id.",
"type": "text/plain"
},
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "offset",
"value": "0",
"description": "An integer that designates the offset at which to begin returning results. Defaults to 0."
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "32582933-5b64-4a7f-89ba-024a409e6fc1",
"name": "Returns the card orders associated with the given card id",
"originalRequest": {
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "3ae9fede-75d7-4243-8ac6-164b4d7a4ea7",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "offset",
"value": "0"
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"card not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": []
},
{
"id": "7bd064eb-8c28-40ef-9468-0fac7df90525",
"name": "Create",
"request": {
"name": "Create",
"description": {
"content": "Creates a new card order given information",
"type": "text/plain"
},
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "$ref"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"key": "quantity",
"value": "",
"description": "(Required) The quantity of cards in the order (minimum 10,000)."
}
]
}
},
"response": [
{
"id": "57c5b485-c349-40a5-8ddf-73aa6f1991c2",
"name": "Card order created successfully",
"originalRequest": {
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) The quantity of cards in the order (minimum 10,000).",
"type": "text/plain"
},
"key": "quantity",
"value": "10000"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "fb27ab21-a7d5-4e6b-ad1c-f4926cef5efc",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"cards",
":card_id",
"orders"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "card_id",
"description": "(Required) The ID of the card to which the card orders belong."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "POST",
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"disabled": false,
"description": {
"content": "(Required) The quantity of cards in the order (minimum 10,000).",
"type": "text/plain"
},
"key": "quantity",
"value": "10000"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"to address not found\",\n \"status_code\": 404\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"id": "a6e08686-4ddd-46a2-b7a1-d2bdc8ccd147",
"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\n",
"type": "text/plain"
},
"item": [
{
"id": "1f947271-a1e6-417d-a176-4a334b502fc9",
"name": "List",
"request": {
"name": "List",
"description": {
"content": "Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first.",
"type": "text/plain"
},
"url": {
"path": [
"cards"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "limit",
"value": "10",
"description": "How many results to return."
},
{
"disabled": false,
"key": "before",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "after",
"value": "",
"description": "`before` and `after` are both optional but only one of them can be in the query at a time.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
},
{
"disabled": false,
"key": "include",
"value": "",
"description": "Request that the response include the total count by specifying `include=[\"total_count\"]`.\n"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "$ref"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "63299c00-ea1f-456a-b160-3f19d4370cbc",
"name": "Returns a list of card objects",
"originalRequest": {
"url": {
"path": [
"cards"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": ""
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: basic",
"type": "text/plain"
},
"key": "Authorization",
"value": "Basic "
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "$ref"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"id": "ba189c24-7698-48c8-84aa-fe9228d31b92",
"name": "Error",
"originalRequest": {
"url": {
"path": [
"cards"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "limit",
"value": "10"
},
{
"key": "before",
"value": ""
},
{
"key": "after",
"value": ""
},
{
"key": "include",
"value": ""
},
{
"key": "include",
"value": "