Lob.com Creatives API is one of 32 APIs that Lob.com 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.
This API exposes
3 operations
across 2 paths,
and defines 53 schemas.
It is described by OpenAPI 3.2.0, at version 1.22.0.
Requests are made against a single base URL, https://api.lob.com/v1.
The identity and technical contract details declared by the specification.
returned-2
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
tmpl_id
string
Unique identifier prefixed with tmpl. ID of a saved [HTML template](section/HTML-Templates).
card_id
string
Unique identifier prefixed with card.
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…
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…
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
crv_id
string
Unique identifier prefixed with crv.
returned-4
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
double_sided
boolean
Set this attribute to true for double sided printing, or false for for single sided printing. Defaults to true.
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_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…
campaign_list
array
Array of campaigns associated with the creative ID
writable-3
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
creative_base
object
3 properties
local_file_path
string
The path to a local file.
letter_add_on_types
string
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.
lob_base
object
4 properties
3 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…
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…
cmp_schedule_type
string
How the campaign should be scheduled. Only value available today is immediate.
adr_id
string
Unique identifier prefixed with adr.
postcard_size
string
Specifies the size of the postcard. Only 4x6 postcards can be sent to international destinations.
buckslip_id
string
Unique identifier prefixed with bck.
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_created
string
A timestamp in ISO 8601 format of the date the resource was created.
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
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…
campaign_writable
object
11 properties
3 required
print_speed
stringnull
A string designating the mail speed type: core - 2 production business days
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…
address_fields_us
object
5 properties
4 required
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
returned-3
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
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
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
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…
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…
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…
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…
deleted
boolean
Only returned if the resource has been successfully deleted.
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.
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
cmp_id
string
Unique identifier prefixed with cmp.
object
string
Value is resource type.
writable-2
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
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…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lob.com publishes across the network.
