Lob.com Template Versions API
These API endpoints allow you to create, retrieve, update and delete versions of reusable HTML templates for use with the Print & Mail API. back to top
OpenAPI Specification
openapi: 3.0.3
info:
title: Lob Accounts Template Versions API
version: 1.22.0
description: '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. <p>
'
license:
name: MIT
url: https://mit-license.org/
contact:
name: Lob Developer Experience
url: https://support.lob.com/
email: lob-openapi@lob.com
termsOfService: https://www.lob.com/legal
servers:
- url: https://api.lob.com/v1
description: production
security:
- basicAuth: []
tags:
- name: Template Versions
description: 'These API endpoints allow you to create, retrieve, update and delete versions of reusable HTML templates for use with the Print & Mail API.
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
'
paths:
/templates/{tmpl_id}/versions/{vrsn_id}:
parameters:
- in: path
name: tmpl_id
description: The ID of the template to which the version belongs.
required: true
schema:
$ref: '#/components/schemas/tmpl_id'
- in: path
name: vrsn_id
description: id of the template_version
required: true
schema:
$ref: '#/components/schemas/vrsn_id'
get:
operationId: template_version_retrieve
summary: Retrieve
description: Retrieves the template version with the given template and version ids.
tags:
- Template Versions
responses:
'200':
description: Returns the template version with the given template and version ids.
content:
$ref: '#/components/mediaTypes/template_version'
default:
$ref: '#/components/responses/template_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121/versions/vrsn_534e339882d2282 \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
label: CURL
- lang: Typescript
source: "try {\n const templateVersion = await new TemplateVersionsApi(config).get('tmpl_xxxx', 'vrsn_xxxx');\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: 'This feature is not currently supported by this library.
'
label: NODE
- lang: Ruby
source: "templateVersionApi = TemplateVersionsApi.new(config)\n\nbegin\n retrievedTemplateVersion = templateVersionApi.get(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\")\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = TemplateVersionsApi(api_client)\n\ntry:\n template_version = api.get(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\")\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\TemplateVersionsApi($config, new GuzzleHttp\\Client());\n\ntry {\n $result = $apiInstance->get(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\");\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "TemplateVersionsApi apiInstance = new TemplateVersionsApi(config);\n\ntry {\n TemplateVersion response = apiInstance.get(\"vrsn_534e339882d2282\");\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: 'This feature is not currently supported by this library.
'
label: ELIXIR
- lang: CSharp
source: "TemplateVersionsApi api = new TemplateVersionsApi(config);\n\ntry {\n TemplateVersion response = api.get(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\");\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\nfetchedTemplateVersion, _, err := apiClient.TemplateVersionsApi.Get(context,\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\").Execute()\n\nif err != nil {\n return err\n}\n"
label: GO
post:
operationId: template_version_update
summary: Update
description: Updates the template version with the given template and version ids.
tags:
- Template Versions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/template_version_updatable'
example:
description: Some description
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/template_version_updatable'
example:
description: Some description
multipart/form-data:
schema:
$ref: '#/components/schemas/template_version_updatable'
example:
description: Some description
responses:
'200':
$ref: '#/components/responses/post_template_version'
default:
$ref: '#/components/responses/template_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121/versions/vrsn_534e339882d2282 \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -d \"description=Updated description\"\n"
label: CURL
- lang: Typescript
source: "const TemplateVersions = new TemplateVersionsApi(config);\n\ntry {\n const updateData = new TemplateVersionUpdatable({\n description: 'updated template'\n });\n const updateTemplateVersion = await TemplateVersions.update('vrsn_xxxx', updateData);\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: 'This feature is not currently supported by this library.
'
label: NODE
- lang: Ruby
source: "templateVersionUpdatable = TemplateUpdate.new({\n description: \"updated template version\",\n})\n\ntemplateVersionApi = TemplateVersionsApi.new(config)\n\nbegin\n updatedTemplateVersion = templateVersionApi.update(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\", templateVersionUpdatable)\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = TemplateVersionsApi(api_client)\n\nupdate_data = TemplateVersionUpdatable(\n description = \"updated template\"\n)\n\ntry:\n update_template_version = api.update(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\", update_data)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\TemplateVersionsApi($config, new GuzzleHttp\\Client());\n\n$templateVersionUpdate = new OpenAPI\\Client\\Model\\TemplateUpdate(array(\n \"description\" => \"Updated template version\"\n));\n\ntry {\n $result = $apiInstance->update(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\", $templateVersionUpdate);\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: 'This feature is not currently supported by this library.
'
label: JAVA
- lang: Elixir
source: 'This feature is not currently supported by this library.
'
label: ELIXIR
- lang: CSharp
source: "TemplateVersionsApi api = new TemplateVersionsApi(config);\nTemplateVersionUpdatable update = new TemplateVersionUpdatable(\"update template\", EngineHtml.Handlebars);\n\ntry {\n api.update(\"tmpl_c94e83ca2cd5121\", \"vrsn_534e339882d2282\", update);\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\nvar templateWritable = *lob.NewTemplateWritable(\"<html>Updated HTML for Template 1/html>\")\nvar templateVersionWritable = *lob.NewTemplateVersionWritable(\"<html>Updated HTML for Template 1/html>\")\ncreatedTemplate, _, _ := apiClient.TemplatesApi.Create(context).TemplateWritable(templateWritable).Execute()\n\ncreatedTemplateVersion, _, err := apiClient.TemplateVersionsApi.Create(context, createdTemplate.Id).TemplateVersionWritable(templateVersionWritable).Execute()\ncreatedTemplateVersion.SetDescription(\"New Template Version\")\nresp, _, err := apiClient.TemplatesApi.Update(context, createdTemplate.Id, createdTemplateVersion.Id).TemplateVersionWritable(templateVersionWritable).Execute()\n\nif err != nil {\n return err\n}\n"
label: GO
delete:
operationId: template_version_delete
summary: Delete
description: Permanently deletes a template version. A template's `published_version` can not be deleted.
tags:
- Template Versions
responses:
'200':
$ref: '#/components/responses/template_version_deleted'
default:
$ref: '#/components/responses/template_error'
x-codeSamples:
- lang: Shell
source: "curl -X DELETE https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions/vrsn_534e339882d2282 \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
label: CURL
- lang: Typescript
source: "try {\n const deleteTemplateVersion = await new TemplateVersionsApi(config).delete(\"tmpl_xxxx\",\"vrsn_xxxx\");\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: 'This feature is not currently supported by this library.
'
label: NODE
- lang: Ruby
source: "templateVersionApi = TemplateVersionsApi.new(config)\n\nbegin\n deletedTemplateVersion = templateVersionApi.delete(\"tmpl_4aa14648113e45b\", \"vrsn_534e339882d2282\")\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = TemplateVersionsApi(api_client)\n\ntry:\n deleted_resource = api.delete(\"tmpl_4aa14648113e45b\", \"vrsn_534e339882d2282\")\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: 'This feature is not currently supported by this library.
'
- lang: Java
source: 'This feature is not currently supported by this library.
'
label: JAVA
- lang: Elixir
source: 'This feature is not currently supported by this library.
'
label: ELIXIR
- lang: CSharp
source: "TemplateVersionsApi api = new TemplateVersionsApi(config);\n\ntry {\n TemplateVersionDeletion response = api.delete(\"tmpl_xxx\", \"vrsn_xxx\");\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\ndeletedTemplateVersion, _, err := apiClient.TemplateVersionsApi.Delete(context, \"tmpl_4aa14648113e45b\", \"vrsn_534e339882d2282\").Execute()\n\nif err != nil {\n return err\n}\n"
label: GO
/templates/{tmpl_id}/versions:
get:
operationId: template_versions_list
summary: List
description: 'Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.
'
tags:
- Template Versions
parameters:
- in: path
name: tmpl_id
description: The ID of the template associated with the retrieved versions
required: true
schema:
$ref: '#/components/schemas/tmpl_id'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/before_after'
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/date_created'
responses:
'200':
$ref: '#/components/responses/all_template_versions'
default:
$ref: '#/components/responses/template_error'
x-codeSamples:
- lang: Shell
source: "curl -X GET \"https://api.lob.com/v1/templates/tmpl_ea6e6a1abf01703/versions?limit=2\" \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:\n"
label: CURL
- lang: Typescript
source: "try {\n const templateVersions = await new TemplateVersionsApi(config).list(tmpl_xxxx);\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: 'This feature is not currently supported by this library.
'
label: NODE
- lang: Ruby
source: "templateVersionsApi = TemplateVersionsApi.new(config)\n\nbegin\n templateVersions = templateVersionsApi.list(\"tmpl_dadaaf7b76c9f25\", { limit: 2 })\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = TemplateVersionsApi(api_client)\n\ntry:\n template_versions = api.list(\"tmpl_dadaaf7b76c9f25\", limit=2)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\TemplateVersionsApi($config, new GuzzleHttp\\Client());\n\ntry {\n $result = $apiInstance->list(\n tmpl_dadaaf7b76c9f25, // tmplId\n 2, // limit\n );\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "TemplateVersionsApi apiInstance = new TemplateVersionsApi(config);\n\ntry {\n List response = apiInstance.list(\n \"tmpl_dadaaf7b76c9f25\", // tmplId\n 2, // limit\n null, // before\n null, // after\n null, // include\n null // dateCreated\n );\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: 'This feature is not currently supported by this library.
'
label: ELIXIR
- lang: CSharp
source: "TemplateVersionsApi api = new TemplateVersionsApi(config);\n\nList<string> includeList = new List<string>();\nincludeList.Add(\"total_count\");\nDictionary<String, DateTime> dateCreated = new Dictionary<String, DateTime>();\nDateTime dateCreatedDate = DateTime.Today.AddMonths(-1);\ndateCreated.Add(\"lt\", dateCreatedDate);\n\ntry {\n TemplateVersionList response = api.list(\n \"tmpl_dadaaf7b76c9f25\", // tmplId\n 2, // limit\n null, // before\n null, // after\n includeList, // include\n dateCreated // dateCreated\n );\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\nTemplateVersionList = apiClient.TemplateVersionsApi.List(context, \"tmpl_4aa14648113e45b\").Execute()\nif err != nil {\n return err\n}\n"
label: GO
post:
operationId: create_template_version
summary: Create
description: Creates a new template version attached to the specified template.
tags:
- Template Versions
parameters:
- in: path
name: tmpl_id
description: The ID of the template the new version will be attached to
required: true
schema:
$ref: '#/components/schemas/tmpl_id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/template_version_writable'
example:
description: Some Description
html: <html>HTML for {{name}}</html>
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/template_version_writable'
example:
description: Some Description
html: <html>HTML for {{name}}</html>
multipart/form-data:
schema:
$ref: '#/components/schemas/template_version_writable'
example:
description: Some Description
html: <html>HTML for {{name}}</html>
responses:
'200':
$ref: '#/components/responses/post_template_version'
default:
$ref: '#/components/responses/template_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions \\\n -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \\\n -d \"description=Second Version\" \\\n --data-urlencode \"html=<html>Second HTML for {{name}}</html>\"\n"
label: CURL
- lang: Typescript
source: "const templateVersionCreate = new TemplateVersionWritable({\n description: 'Newer Template',\n html: '<html>Updated HTML for {{name}}</html>'\n});\n\ntry {\n const myTemplateVersion = await new TemplateVersionsApi(config).create('tmpl_xxxx', templateVersionCreate);\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: 'This feature is not currently supported by this library.
'
label: NODE
- lang: Ruby
source: "templateVersionCreate = TemplateVersionWritable.new({\n description: \"Second Version\",\n html: \"<html>Second HTML for {{name}}</html>\",\n});\n\ntemplateVersionApi = TemplateVersionsApi.new(config)\n\nbegin\n createdTemplateVersion = templateVersionApi.create(\"tmpl_4aa14648113e45b\", templateVersionCreate)\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "template_version_writable = TemplateVersionWritable(\n description = \"Second Version\",\n html = \"<html>Second HTML for {{name}}</html>\",\n)\n\nwith ApiClient(configuration) as api_client:\n api = TemplateVersionsApi(api_client)\n\ntry:\n created_template_version = api.create(\"tmpl_4aa14648113e45b\", template_version_writable)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\TemplateVersionsApi($config, new GuzzleHttp\\Client());\n$template_version_writable = new OpenAPI\\Client\\Model\\TemplateVersionWritable(\n array(\n \"description\" => \"Second Version\",\n \"html\" => \"<html>Second HTML for {{name}}</html>\",\n )\n);\n\ntry {\n $result = $apiInstance->create(\"tmpl_4aa14648113e45b\", $template_version_writable);\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "TemplateVersionsApi apiInstance = new TemplateVersionsApi(config);\n\ntry {\n TemplateVersionWritable = new TemplateVersionWritable();\n .set(\"Second Version\");\n .set(\"<html>Second HTML for {{name}}</html>\");\n\n TemplateVersion result = apiInstance.create();\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: 'This feature is not currently supported by this library.
'
label: ELIXIR
- lang: CSharp
source: "TemplateVersionsApi api = new TemplateVersionsApi(config);\n\nTemplateVersionWritable templateVersionWritable = new TemplateVersionWritable(\n \"Second Version\", // description\n \"<html>Second HTML for {{name}}</html>\" // html\n);\n\ntry {\n TemplateVersion result = api.create(\"tmpl_4aa14648113e45b\", templateVersionWritable);\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
- lang: Go
source: "var context = context.Background()\ncontext = context.WithValue(suite.ctx, lob.ContextBasicAuth, lob.BasicAuth{UserName: os.Getenv(\"<YOUR_API_KEY>\")})\n\nvar apiClient = *lob.NewAPIClient(configuration)\n\n\nvar templateVersionCreate = *lob.NewTemplateVersionWritable()\ntemplateVersionCreate.SetDescription(\"Second Version\")\ntemplateVersionCreate.SetHtml(\"<html>Second HTML for {{name}}</html>\")\n\n\n\ncreatedtemplateVersion, _, err := apiClient.TemplateVersionsApi.Create(context, \"tmpl_4aa14648113e45b\").TemplateVersionWritable(templateVersionCreate).Execute()\n\nif err != nil {\n return err\n}\n"
label: GO
components:
parameters:
include:
in: query
name: include
description: 'Request that the response include the total count by specifying `include=["total_count"]`.
'
schema:
type: array
items:
type: string
explode: true
date_created:
in: query
name: date_created
description: '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 ≤.'
schema:
$ref: '#/components/schemas/date_filter'
style: deepObject
explode: true
limit:
in: query
name: limit
required: false
description: How many results to return.
schema:
type: integer
minimum: 1
default: 10
maximum: 100
example: 10
before_after:
in: query
name: before/after
required: false
description: '`before` and `after` are both optional but only one of them can be in the query at a time.
'
schema:
allOf:
- type: object
properties:
before:
type: string
description: 'A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response.
'
after:
type: string
description: 'A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response.
'
- oneOf:
- required:
- before
- required:
- after
responses:
all_template_versions:
description: A dictionary with a data property that contains an array of up to `limit` template versions. Each entry in the array is a separate template version object. The previous and next page of template versions can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.<br>If no more template versions are available beyond the current set of returned results, the `next_url` field will be empty.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/list'
- type: object
properties:
data:
type: array
description: list of template versions
items:
$ref: '#/components/schemas/template_version'
example:
data:
- id: vrsn_4d6ff5d868bf630
description: Second Version
html: 'Second HTML for '
date_created: '2017-11-09T05:09:03.665Z'
date_modified: '2018-05-22T22:01:10.479Z'
object: version
- id: vrsn_2a17159c1911919
description: Test Template
html: 'HTML for '
date_created: '2017-11-09T05:08:40.004Z'
date_modified: '2018-05-22T22:01:11.309Z'
object: version
object: list
count: 2
post_template_version:
description: Returns the template version with the given template and version ids.
headers:
ratelimit-limit:
$ref: '#/components/headers/ratelimit-limit'
ratelimit-remaining:
$ref: '#/components/headers/ratelimit-remaining'
ratelimit-reset:
$ref: '#/components/headers/ratelimit-reset'
content:
$ref: '#/components/mediaTypes/template_version'
template_version_deleted:
description: Deleted
content:
application/json:
schema:
$ref: '#/components/schemas/template_version_deletion'
example:
value:
id: vrsn_123456789
deleted: true
template_error:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
example:
error:
code: invalid
message: html is required
status_code: 422
headers:
ratelimit-limit:
description: The rate limit for a given endpoint.
schema:
type: integer
example: 150
ratelimit-reset:
description: 'The time at which the rate limit window resets in <a href="https://en.wikipedia.org/wiki/Unix_time" target="_blank">UTC epoch seconds</a>
'
schema:
type: integer
example: 1528749846
ratelimit-remaining:
description: The number of requests remaining in the current window.
schema:
type: integer
example: 100
schemas:
object:
type: string
description: Value is resource type.
date_created:
type: string
format: date-time
description: A timestamp in ISO 8601 format of the date the resource was created.
lob_base:
type: object
required:
- date_created
- date_modified
- object
properties:
date_created:
$ref: '#/components/schemas/date_created'
date_modified:
$ref: '#/components/schemas/date_modified'
deleted:
$ref: '#/components/schemas/deleted'
object:
$ref: '#/components/schemas/object'
date_filter:
type: object
additionalProperties:
type: string
description: '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 ≤.'
tmpl_id:
type: string
description: Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
pattern: ^tmpl_[a-zA-Z0-9]+$
vrsn_id:
type: string
description: Unique identifier prefixed with `vrsn_`.
pattern: ^vrsn_[a-zA-Z0-9]+$
resource_description:
type: string
description: 'An internal description that identifies this resource. Must be no longer than 255 characters.
'
maxLength: 255
nullable: true
template_version_deletion:
description: 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 indicates an error on Lob's end.
properties:
id:
$ref: '#/components/schemas/vrsn_id'
deleted:
$ref: '#/components/schemas/deleted'
list:
type: object
description: Multiple items returned in order
properties:
object:
$ref: '#/components/schemas/object'
next_url:
type: string
description: Url of next page of items in list.
nullable: true
previous_url:
type: string
description: Url of previous page of items in list.
nullable: true
count:
$ref: '#/components/schemas/count'
total_count:
type: integer
description: Indicates the total number of records. Provided when the request specifies an "include" query parameter
date_modified:
type: string
format: date-time
description: A timestamp in ISO 8601 format of the date the resource was last modified.
engine:
type: string
description: "The engine used to combine HTML template with merge variables.\n * `legacy` - Lob's original engine\n * `handlebars`\n"
enum:
- legacy
- handlebars
nullable: true
default: legacy
template_version_writable:
type: object
required:
- html
properties:
description:
$ref: '#/components/schemas/resource_description'
html:
$ref: '#/components/schemas/template_html'
engine:
$ref: '#/components/schemas/engine'
required_vars:
$ref: '#/components/schemas/template_required_vars'
template_version:
allOf:
- $ref: '#/components/schemas/template_version_writable'
- $ref: '#/components/schemas/lob_base'
- type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/vrsn_id'
suggest_json_editor:
type: boolean
description: 'Used by frontend, true if the template uses advanced features.
'
merge_variables:
type: object
description: 'Object representing the keys of every merge variable present in the template. It has one key named ''keys'', and its value is an array of strings.
'
object:
type: string
description: Value is resource type.
enum:
- version
default: version
deleted:
type: boolean
description: Only returned if the resource has been successfully deleted.
template_required_vars:
type: array
items:
type: string
description: 'An array of required variables to be used in a template. Only available for `handlebars` templates.
'
template_html:
type: string
description: 'An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details:
- [Postcards](#operation/postcard_create) - `front` and `back`
- [Self Mailers](#operation/self_mailer_create) - `inside` and `outside`
- [Letters](#operation/letter_create) - `file`
- [Checks](#operation/check_create) - `check_bottom` and `attachment`
- [Cards](#operation/card_create) - `front` and `back`
If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.
'
maxLength: 100000
template_version_updatable:
type: object
properties:
description:
$ref: '#/components/schemas/resource_description'
engine:
$ref: '#/components/schemas/engine'
required_vars:
$ref: '#/components/schemas/template_required_vars'
count:
type: integer
description: number of resources in a set
error:
type: object
description: 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 indicates an error on Lob's end.
required:
- error
properties:
error:
type: object
required:
- message
- status_code
- code
properties:
message:
type: string
description: A human-readable message with more details about the error
example: Rate limit exceeded. Please wait 5 seconds and try your request again.
status_code:
$ref: '#/components/schemas/failure_status_code'
code:
type: string
enum:
- bad_request
- conflict
- feature_limit_reached
- internal_server_error
- invalid
- not_deletable
- not_found
- request_timeout
- service_unavailable
- unrecognized_endpoint
- unsupported_lob_version
- address_length_exceeds_limit
- bank_account_already_verified
- bank_error
- billing_address_required
- custom_envelope_inventory_depleted
- deleted_bank_account
- failed_deliverability_strictness
- file_pages_below_min
- file_pages_exceed_max
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lobcom/refs/heads/main/openapi/lobcom-template-versions-api-openapi.yml