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.com Buckslips API

The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a minimum send quantity of 5,000 letters.The API provides endpoints for creating buckslips, retrieving individual buckslips, creating buckslip orders, and retrieving a list of buckslips.back to top

Lob.com Buckslips 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 Buckslips. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 22 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.

5 operations 2 paths 22 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 5

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

Buckslips 5

The Buckslips endpoint allows you to easily create buckslips that can later be used as add-ons for Letters Campaigns. Note that a Letter Campaign with Buckslip add-on requires a m…

GET
/buckslips
List
buckslips_list 3 params → 200default
POST
/buckslips
Create
buckslip_create body → 200default
GET
/buckslips/{buckslip_id}
Retrieve
buckslip_retrieve 1 param → 200default
PATCH
/buckslips/{buckslip_id}
Update
buckslip_update 1 param body → 200default
DELETE
/buckslips/{buckslip_id}
Delete
buckslip_delete 1 param → 200default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are list (5 properties), lob_base (4 properties), thumbnail (3 properties), buckslip_updatable (3 properties). Each schema is shown below with its type and property counts.

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
count
integer
number of resources in a set
local_file_path
string
The path to a local file.
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…
buckslip_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
buckslip_base
object
2 properties
lob_base
object
4 properties 3 required
buckslip_description
stringnull
Description of the buckslip.
buckslip_order
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…
buckslip_id
string
Unique identifier prefixed with bck.
date_created
string
A timestamp in ISO 8601 format of the date the resource was created.
bo_id
string
Unique identifier prefixed with bo.
list
object
Multiple items returned in order
5 properties
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
buckslip_updatable
object
3 properties
buckslip
buckslip_editable
deleted
boolean
Only returned if the resource has been successfully deleted.
remote_file_url
string
The location of a remote file. Remote URLs have a 5 MB file size limit and must be downloaded within 40 seconds.
object
string
Value is resource type.
thumbnail
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lobcom-buckslips-api-openapi.yml Raw ↑

Other APIs Lob.com publishes across the network.

Lob.com Accounts API
Lob.com Addresses API
Lob.com Bank Accounts API
Lob.com Billing Groups API
Lob.com Booklets API
Lob.com Buckslip Orders API
Lob.com Campaigns API
Lob.com Card Orders API
Lob.com Cards API
Lob.com Checks API
Lob.com Creatives API
Lob.com Identity Validation API
Where this information came from

This is an independent, third-party profile of Lob.com Buckslips 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.