How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lob Templates API

These API endpoints allow you to create, retrieve, update and delete reusable HTML templates for use with the Print & Mail API.back to top

Lob Templates API is one of 48 APIs that Lob publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 4 paths, and defines 25 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.

10 operations 4 paths 25 schemas 2 DELETE4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.20.2
Server
https://api.lob.com/v1
Authentication
HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Lob Templates API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Templates 10

These API endpoints allow you to create, retrieve, update and delete reusable HTML templates for use with the Print & Mail API. back to top

GET
/templates/{tmpl_id}/versions/{vrsn_id}
Retrieve
template_version_retrieve 2 params → 200default
POST
/templates/{tmpl_id}/versions/{vrsn_id}
Update
template_version_update 2 params body → 200default
DELETE
/templates/{tmpl_id}/versions/{vrsn_id}
Delete
template_version_delete 2 params → 200default
GET
/templates/{tmpl_id}/versions
List
template_versions_list 5 params → 200default
POST
/templates/{tmpl_id}/versions
Create
create_template_version 1 param body → 200default
GET
/templates/{tmpl_id}
Retrieve
template_retrieve 1 param → 200default
POST
/templates/{tmpl_id}
Update
template_update 1 param body → 200default
DELETE
/templates/{tmpl_id}
Delete
template_delete 1 param → 200default
GET
/templates
List
templates_list 5 params → 200default
POST
/templates
Create
create_template body → 200default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are template (9 properties), template_writable (5 properties), list (5 properties), template_version_writable (4 properties). Each schema is shown below with its type and property counts.

count
integer
number of resources in a set
template_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
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…
date_filter
object
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 e, and lte is d.
template_version_writable
object
4 properties 1 required
template_version_updatable
object
3 properties
list
object
Multiple items returned in order
5 properties
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
lob_base
object
4 properties 3 required
template_update
object
2 properties
template_required_vars
array
An array of required variables to be used in a template. Only available for handlebars templates.
object
string
Value is resource type.
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.
template
object
9 properties 3 required
vrsn_id
string
Unique identifier prefixed with vrsn.
template_html
string
An HTML string of less than 100,000 characters to be used as the publishedversion of this template. See [here](section/HTML-Examples) for guidance on designing…
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
template_writable
object
5 properties 1 required
deleted
boolean
Only returned if the resource has been successfully deleted.
template_version_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
engine
stringnull
The engine used to combine HTML template with merge variables. legacy - Lob's original engine handlebars
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
template_version

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lob-templates-api-openapi.yml Raw ↑

Other APIs Lob publishes across the network.

Lob Accounts API
Lob Addresses API
Lob Bank Accounts API
Lob Bank_id API
Lob Bg_id API
Lob Billing Groups API
Lob Booklet_id API
Lob Booklets API
Lob Buckslip_id API
Lob Buckslips API
Lob Bulk API
Lob Campaigns API
Where this information came from

This is an independent, third-party profile of Lob Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.