The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
+ " fill="currentColor">The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors.
Lob’s Print & Mail and Address Verification APIs help companies transform outdated, manual print-and-mail processes; save 1,000s of hours in processing time by sending mail much more quickly; and increase ROI on offline communications.
@@ -3224,10 +3224,16 @@The unique ID of the specific version of the HTML template used for the front of the postcard. Only filled out when the request contains a valid postcard template ID.
The unique ID of the specific version of the HTML template used for the back of the postcard. Only filled out when the request contains a valid postcard template ID.
An array of tracking_event objects ordered by ascending time. Will not be populated for postcards created in test mode.
The unique ID of the associated campaign if the resource was generated from a campaign.
+Denotes resources created by the provided campaign id, prefixed with cmp_.
The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.
An object describing the reason for failure if the resource failed to render.
+This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.
A string describing the PDF render status:
+processed - the rendering process is currently in progress.rendered - a PDF has been successfully rendered of the mailpiece.failed - one or more issues has caused the rendering process to fail.An object describing the reason for failure if the resource failed to render.
Value is resource type.
Request that the response include the total count by specifying include=["total_count"].
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 ≤.
Filter by metadata key-value pair`.
+Filters resources created by the provided campaign id, prefixed with cmp_.
A string describing the render status:
+processed - the rendering process is currently underway.rendered - the rendering process has completed successfully.failed - the rendering process has failed.Specifies the size of the postcard. Only 4x6 postcards can be sent to international destinations.
true - only return orders (past or future) where send_date is
@@ -3308,7 +3321,7 @@ Required if to address is international. Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification.
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.
Customize and place a QR code on the creative at the required position.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.
| ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. |
| ratelimit-remaining | integer Example: 100 The number of requests remaining in the current window. @@ -3336,10 +3349,16 @@3. Learn more |
address obj with `name` defined (object) or address obj with `company` defined (object) (address_us) | |
| front_template_version_id | string or null^vrsn_[a-zA-Z0-9]+$ The unique ID of the specific version of the HTML template used for the front of the postcard. Only filled out when the request contains a valid postcard template ID. |
| back_template_version_id | string or null^vrsn_[a-zA-Z0-9]+$ The unique ID of the specific version of the HTML template used for the back of the postcard. Only filled out when the request contains a valid postcard template ID. |
Array of objects or null (tracking_event_normal) An array of tracking_event objects ordered by ascending | |
| campaign_id | string or null The unique ID of the associated campaign if the resource was generated from a campaign. + |
| campaign_id | string or null (campaign_id) ^cmp_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
| use_type | string or null (psc_use_type) Enum: "marketing" "operational" null The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article. - |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | any (The status of the postcard.) Enum: "processed" "rendered" "failed" |
object or null An object describing the reason for failure if the resource failed to render. + | |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status: +
|
object or null An object describing the reason for failure if the resource failed to render. | |
| object | string Default: "postcard" Value: "postcard" Value is resource type. |
You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the send_date has passed, the mailpiece can be canceled. If a date in the format 2017-11-01 is passed, it will evaluate to midnight UTC of that date (2017-11-01T00:00:00.000Z). If a datetime is passed, that exact time will be used. A send_date passed with no time zone will default to UTC, while a send_date passed with a time zone will be converted to UTC.
Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.
Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.
A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its send_date.
A timestamp in ISO 8601 format of the date the resource was created.
A timestamp in ISO 8601 format of the date the resource was last modified.
@@ -3374,8 +3393,15 @@Unique identifier prefixed with vrsn_.
Value is resource type.
An array of certified tracking events ordered by ascending time. Not populated in test mode.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.
An object describing the reason for failure if the resource failed to render.
+This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.
A string describing the PDF render status:
+processed - the rendering process is currently in progress.rendered - a PDF has been successfully rendered of the mailpiece.failed - one or more issues has caused the rendering process to fail.Denotes resources created by the provided campaign id, prefixed with cmp_.
An object describing the reason for failure if the resource failed to render.
curl -X GET "https://api.lob.com/v1/self_mailers/sfm_8ffbe811dea49dcf" \ @@ -3403,7 +3429,14 @@3. Learn more
Filter by 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 ≤.
A string designating the mail postage type: * usps_first_class - (default) * usps_standard - a cheaper option which is less predictable and takes longer to deliver. usps_standard cannot be used with 4x6 postcards or for any postcards sent outside of the United States.
Sorts items by ascending or descending dates. Use either date_created or send_date, not both.
Sorts items by ascending or descending dates. Use either date_created or send_date, not both.
Filters resources created by the provided campaign id, prefixed with cmp_.
A string describing the render status:
+processed - the rendering process is currently underway.rendered - the rendering process has completed successfully.failed - the rendering process has failed.| object | string (object) Value is resource type. |
| next_url | string or null Url of next page of items in list. @@ -3451,11 +3484,11 @@3. Learn more |
| merge_variables | object or null (merge_variables) <= 25000 characters You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: |
string or string (send_date) A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the | |
| size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
| size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object))) Required if | |
| billing_group_id | string (billing_group_id) An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information. |
object (qr_code) Customize and place a QR code on the creative at the required position. - | |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. |
| ratelimit-remaining | integer Example: 100 The number of requests remaining in the current window. @@ -3474,7 +3507,7 @@3. Learn more |
| merge_variables | object or null (merge_variables) <= 25000 characters You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: |
string or string (send_date) A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the | |
| size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
| size | string (self_mailer_size) Default: "6x18_bifold" Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold" Specifies the size of the self mailer. The |
Array of objects (thumbnail) | |
| expected_delivery_date | string <date> (expected_delivery_date) A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its |
| date_created | string <date-time> (date_created) A timestamp in ISO 8601 format of the date the resource was created. |
| date_modified | string <date-time> (date_modified) A timestamp in ISO 8601 format of the date the resource was last modified. @@ -3485,8 +3518,15 @@3. Learn more |
| inside_template_version_id | string or null^vrsn_[a-zA-Z0-9]+$ Unique identifier prefixed with |
| object | string Default: "self_mailer" Value: "self_mailer" Value is resource type. |
Array of objects (tracking_event_certified) An array of certified tracking events ordered by ascending | |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | any (The status of the self mailer.) Enum: "processed" "rendered" "failed" |
object or null An object describing the reason for failure if the resource failed to render. + | |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status: +
|
| campaign_id | string or null (campaign_id) ^cmp_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
object or null An object describing the reason for failure if the resource failed to render. |
{- "description": "Demo Self Mailer job",
- "to": "adr_bae820679f3f536b",
- "from": "adr_210a8d4b0b76d77b",
- "size": "12x9_bifold",
- "metadata": {
- "spiffy": "true"
}, - "mail_type": "usps_standard",
- "merge_variables": {
- "name": "Harry"
}, - "send_date": "2017-11-01T00:00:00.000Z",
- "use_type": "marketing",
- "qr_code": {
- "position": "relative",
- "width": "2.5",
- "top": "2.5",
- "right": "2.5",
- "pages": "inside,outside"
}, - "fsc": true
}{- "id": "sfm_8ffbe811dea49dcf",
- "description": "April Campaign",
- "metadata": { },
- "to": {
- "id": "adr_bae820679f3f536b",
- "description": null,
- "name": "HARRY ZHANG",
- "company": null,
- "phone": null,
- "email": null,
- "address_line1": "210 KING ST STE 6100",
- "address_line2": null,
- "address_city": "SAN FRANCISCO",
- "address_state": "CA",
- "address_zip": "94107-1741",
- "address_country": "UNITED STATES",
- "metadata": { },
- "date_created": "2017-09-05T17:47:53.767Z",
- "date_modified": "2017-09-05T17:47:53.767Z",
- "deleted": true,
- "object": "address"
}, - "from": {
- "id": "adr_210a8d4b0b76d77b",
- "description": null,
- "name": "LEORE AVIDAR",
- "company": null,
- "phone": null,
- "email": null,
- "address_line1": "210 KING ST STE 6100",
- "address_line2": null,
- "address_city": "SAN FRANCISCO",
- "address_state": "CA",
- "address_zip": "94107-1741",
- "address_country": "UNITED STATES",
- "metadata": { },
- "date_created": "2017-09-05T17:47:53.767Z",
- "date_modified": "2017-09-05T17:47:53.767Z",
- "deleted": true,
- "object": "address"
}, - "outside_template_id": "tmpl_a3cb937f26d7eec",
- "inside_template_id": "tmpl_a3cb937f26d7eec",
- "inside_template_version_id": "vrsn_bfdf70893b00a85",
- "outside_template_version_id": "vrsn_bfdf70893b00a85",
- "carrier": "USPS",
- "tracking_events": [ ],
- "thumbnails": [
- {
}, - {
}
], - "merge_variables": {
- "name": null
}, - "size": "6x18_bifold",
- "mail_type": "usps_first_class",
- "expected_delivery_date": "2021-03-24",
- "date_created": "2021-03-16T18:40:40.504Z",
- "date_modified": "2021-03-16T18:40:40.504Z",
- "send_date": "2021-03-16T18:45:40.493Z",
- "use_type": "marketing",
- "fsc": false,
- "object": "self_mailer"
}The letters endpoint allows you to easily print and mail letters. The API provides endpoints for @@ -3531,9 +3571,15 @@
A signed link served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
Unique identifier prefixed with tmpl_. ID of a saved HTML template.
Unique identifier prefixed with vrsn_.
The unique ID of the associated campaign if the resource was generated from a campaign.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.
An object describing the reason for failure if the resource failed to render.
+Denotes resources created by the provided campaign id, prefixed with cmp_.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.
A string describing the PDF render status:
+
processed - the rendering process is currently in progress.rendered - a PDF has been successfully rendered of the mailpiece.failed - one or more issues has caused the rendering process to fail.An object describing the reason for failure if the resource failed to render.
Value is resource type.
Request that the response include the total count by specifying include=["total_count"].
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 ≤.
Filter by metadata key-value pair`.
+Filters resources created by the provided campaign id, prefixed with cmp_.
A string describing the render status:
+processed - the rendering process is currently underway.rendered - the rendering process has completed successfully.failed - the rendering process has failed.Set to true to return only color letters. Set to false to return only black & white letters.
true - only return orders (past or future) where send_date is
@@ -3624,7 +3677,7 @@ Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate Print & Mail Edition to gain access.
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.
Customize and place a QR code on the creative at the required position.
-This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.
This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.
| ratelimit-limit | integer Example: 150 The rate limit for a given endpoint. |
| ratelimit-remaining | integer Example: 100 The number of requests remaining in the current window. @@ -3665,9 +3718,15 @@3. Learn more |
| url | string (signed_link) ^https://lob-assets.com/(letters|postcards|ba... A signed link served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. |
| template_id | string^tmpl_[a-zA-Z0-9]+$ Unique identifier prefixed with |
| template_version_id | string^vrsn_[a-zA-Z0-9]+$ Unique identifier prefixed with |
| campaign_id | string or null The unique ID of the associated campaign if the resource was generated from a campaign. - |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | any (The status of the letter.) Enum: "processed" "rendered" "failed" |
object or null An object describing the reason for failure if the resource failed to render. + | |
| campaign_id | string or null (campaign_id) ^cmp_[a-zA-Z0-9]+$ Denotes resources created by the provided campaign id, prefixed with |
| fsc | boolean Default: false This is in beta. Contact support@lob.com or your account contact to learn more. Not available for |
| status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status: +
|
object or null An object describing the reason for failure if the resource failed to render. | |
| object | string Default: "letter" Value: "letter" Value is resource type. |
Filter by 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 ≤.
A string designating the mail postage type: * usps_first_class - (default) * usps_standard - a cheaper option which is less predictable and takes longer to deliver. usps_standard cannot be used with 4x6 postcards or for any postcards sent outside of the United States.
Sorts items by ascending or descending dates. Use either date_created or send_date, not both.
Sorts items by ascending or descending dates. Use either date_created or send_date, not both.
A string describing the render status:
+processed - the rendering process is currently underway.rendered - the rendering process has completed successfully.failed - the rendering process has failed.| object | string (object) Value is resource type. |
| next_url | string or null Url of next page of items in list. @@ -3776,7 +3841,13 @@3. Learn more |
| attachment_template_version_id | string^vrsn_[a-zA-Z0-9]+$ Unique identifier prefixed with |
Array of objects (thumbnail) | |
| expected_delivery_date | string <date> (expected_delivery_date) A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its |
Array of objects or null (tracking_event_normal) An array of tracking_event objects ordered by ascending | |
| status | any (The status of the check.) Enum: "processed" "rendered" "failed" |
object or null An object describing the reason for failure if the resource failed to render. + | |
| status | string (status) Enum: "processed" "rendered" "failed" A string describing the PDF render status: +
|
object or null An object describing the reason for failure if the resource failed to render. | |
| object | string Default: "check" Value: "check" Value is resource type. |
| deleted | boolean (deleted) Only returned if the resource has been successfully deleted. |
Unique identifier prefixed with vrsn_.
A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its send_date.
An array of tracking_event objects ordered by ascending time. Will not be populated for checks created in test mode.
An object describing the reason for failure if the resource failed to render.
+A string describing the PDF render status:
+processed - the rendering process is currently in progress.rendered - a PDF has been successfully rendered of the mailpiece.failed - one or more issues has caused the rendering process to fail.An object describing the reason for failure if the resource failed to render.
Value is resource type.
Only returned if the resource has been successfully deleted.
| DELIVERABILITY OF SAMPLE RESPONSE | @@ -1014,83 +1152,137 @@ tags:
|---|
| FONT NAME | @@ -1736,55 +2163,89 @@ tags:Type 1 |
|---|
| NAME | @@ -1955,27 +2416,43 @@ tags:false |
|---|
components[zip_code_type]components[record_type]components[carrier_route_type]deliverability_analysis[dpv_footnotes]| ADDRESS TYPE FOR SAMPLE RESPONSE | @@ -2241,74 +2738,119 @@ tags:
|---|