Lob Ltr_id API is one of 48 APIs that Lob publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ltr_id. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
2 operations
across 1 path,
and defines 65 schemas.
It is described by OpenAPI 3.2.0, at version 1.20.2.
Requests are made against a single base URL, https://api.lob.com/v1.
The identity and technical contract details declared by the specification.
expected_delivery_date
string
A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its senddate.
ltr_use_type
stringnull
The use type for each mailpiece. Can be one of marketing, operational, or null. Null usetype is only allowed if an account default usetype is selected in Accou…
signed_link
string
A [signed link](section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a…
failure_status_code
integer
A conventional HTTP status code: 401 - Authorization error with your API key or account 403 - Forbidden error with your API key or account 404 - The requested…
evnt_id
string
Unique identifier prefixed with evnt.
merge_variables
objectnull
You can input a merge variable payload object to your template or QR code redirect URLs to render dynamic content. For example, if you have a template like: {{…
company
stringnull
Either name or company is required, you may also add both. Must be no longer than 40 characters. If both name and company are provided, they will be printed on…
generated
object
7 properties
2 required
metadata
object
Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be…
tracking_event_details
object
4 properties
3 required
error
object
Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx…
1 property
1 required
country_extended
string
Must be a 2 letter country short-name code (ISO 3166). Does not accept US, AS, PR, FM, GU, MH, MP, PW, or VI. For these addresses, please use the US verificati…
return_address
Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelo…
mail_type
string
A string designating the mail postage type: uspsfirstclass - (default) uspsstandard - a cheaper option which is less predictable and takes longer to deliver. u…
return_envelope_returned
object
4 properties
card_id
string
Unique identifier prefixed with card.
card_base
object
2 properties
lob_base
object
4 properties
3 required
ltr_id
string
Unique identifier prefixed with ltr.
double_sided
boolean
Set this attribute to true for double sided printing, or false for for single sided printing. Defaults to true.
adr_id
string
Unique identifier prefixed with adr.
tracking_event_base
object
As mail pieces travel through the mail stream, USPS scans their unique barcodes, and Lob processes these mail scans to generate tracking events.
5 properties
4 required
buckslip_base
object
2 properties
buckslip_description
stringnull
Description of the buckslip.
failure_reason
object
An object describing the reason for failure if the resource failed to render.
3 properties
buckslip_id
string
Unique identifier prefixed with bck.
card_description
stringnull
Description of the card.
status
string
A string describing the PDF render status: processed - the rendering process is currently in progress. rendered - a PDF has been successfully rendered of the m…
object
string
Value is resource type.
campaign_id
stringnull
Denotes resources created by the provided campaign id, prefixed with cmp. In the case of snap packs, booklets, and letters with size uslegal, however, the camp…
tmpl_id
string
Unique identifier prefixed with tmpl. ID of a saved [HTML template](section/HTML-Templates).
date_created
string
A timestamp in ISO 8601 format of the date the resource was created.
send_date
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…
letter_deletion
object
Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx…
2 properties
vrsn_id
string
Unique identifier prefixed with vrsn.
address_fields_us
object
5 properties
4 required
color
boolean
Set this key to true if you would like to print in color. Set to false if you would like to print in black and white.
address_fields_intl
object
5 properties
2 required
failure_reason_error
object
Failure error details
7 properties
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
address_placement
string
Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our l…
deleted
boolean
Only returned if the resource has been successfully deleted.
custom_envelope_returned
objectnull
A nested custom envelope object containing more information about the custom envelope used or null if a custom envelope was not used.
3 properties
3 required
bo_id
string
Unique identifier prefixed with bo.
thumbnail
object
3 properties
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lob publishes across the network.
