Lob Creatives API is one of 48 APIs that Lob publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Creatives. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
1 operation
across 1 path,
and defines 52 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.
postcard_size
string
Specifies the size of the postcard. Only 4x6 postcards can be sent to international destinations.
user_provided
stringnull
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, an…
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…
letter_details_writable
object
Properties that the letters in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
10 properties
1 required
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…
crv_inside
The artwork to use as the inside of your self mailer creative. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs mus…
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…
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
card_id
string
Unique identifier prefixed with card.
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…
crv_id
string
Unique identifier prefixed with crv.
returned
object
Properties that the postcards in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
4 properties
lob_base
object
4 properties
3 required
extra_service
stringnull
Add an extra service to your letter. Can only be non-null if mailtype isn't uspsstandard. See pricing for extra costs incurred. certified - track and confirm d…
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.
cmp_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…
crv_file
Notes: - HTML merge variables should not include delimiting whitespace. - All pages of a supplied PDF file must be sized at 8.5"x11", while supplied HTML will…
letter_details_returned
object
Properties that the letters in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
9 properties
crv_front
The artwork to use as the front of your postcard. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at…
buckslip_id
string
Unique identifier prefixed with bck.
campaign_writable
object
10 properties
3 required
self_mailer_details_returned
object
Properties that the self mailers in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
4 properties
crv_back
The artwork to use as the back of your postcard creative. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be…
object
string
Value is resource type.
tmpl_id
string
Unique identifier prefixed with tmpl. ID of a saved [HTML template](section/HTML-Templates).
cmp_id
string
Unique identifier prefixed with cmp.
date_created
string
A timestamp in ISO 8601 format of the date the resource was created.
local_file_path
string
The path to a local file.
creative_base
object
3 properties
cmp_schedule_type
string
How the campaign should be scheduled. Only value available today is immediate.
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.
qr_code_campaigns
object
Customize and place a QR code on all the postcards, letters or self mailers in a campaign. Redirect URLs are fully customizable i.e. they can be standard singl…
8 properties
2 required
self_mailer_details_writable
object
Properties that the self mailers in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
3 properties
1 required
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…
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
campaign_list
array
Array of campaigns associated with the creative ID
self_mailer_size
string
Specifies the size of the self mailer. The 17.75x9trifold size is in beta. Contact support@lob.com or your account contact to learn more.
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
from_attribute
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 v…
crv_outside
The artwork to use as the outside of your self mailer creative. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs mu…
writable
object
Properties that the postcards in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
3 properties
1 required
letter_add_on_types
string
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.
