Lob Sfm_id API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 1 path, the API surfaces 2 operations — 1 DELETE, 1 GET. Each is listed below with its method, path, parameters, and response codes.
Sfm_id 2
GET
/self_mailers/{sfm_id}
Retrieve
self_mailer_retrieve1 param→ 200default
DELETE
/self_mailers/{sfm_id}
Delete
self_mailer_delete1 param→ 200default
Schemas 39
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are generated (7 properties), failure_reason_error (7 properties), tracking_event_base (5 properties), editable (5 properties). Each schema is shown below with its type and property counts.
expected_delivery_date
string
A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its senddate.
editable
object
5 properties
sfm_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…
tracking_event_certified
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 properties2 required
sfm_id
string
Unique identifier prefixed with sfm.
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 properties3 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 property1 required
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…
lob_base
object
4 properties3 required
adr_id
string
Unique identifier prefixed with adr.
address_us
from_us
object
1 property
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 properties4 required
self_mailer_base
failure_reason
object
An object describing the reason for failure if the resource failed to render.
3 properties
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).
self_mailer
address
address_intl
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…
vrsn_id
string
Unique identifier prefixed with vrsn.
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.
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.
self_mailer_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
deleted
boolean
Only returned if the resource has been successfully deleted.
thumbnail
object
3 properties
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Lob Sfm_id 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.
