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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lob

Lob Uploads API

The uploads endpoint allows you to upload audience files that are then associated with a given campaign.At this time, only CSV files are allowed. The API provides endpoints for creating uploads, uploading audience files,and marking uploaded files as ready for processing. The API also provides endpoints for downloading files thatdescribe the results, both successful and not, of the processing.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 6 paths, and defines 16 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.

9 operations 6 paths 16 schemas 1 DELETE4 GET1 PATCH3 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
Contact
Lob Developer Experience
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 9

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

Uploads 9

The uploads endpoint allows you to upload audience files that are then associated with a given campaign. At this time, only CSV files are allowed. The API provides endpoints for c…

GET
/uploads
List
uploads_list 1 param → 200
POST
/uploads
Create
upload_create body → 201422
GET
/uploads/{upl_id}
Retrieve
upload_retrieve 1 param → 200404422
PATCH
/uploads/{upl_id}
Update
upload_update 1 param body → 200404422
DELETE
/uploads/{upl_id}
Delete
upload_delete 1 param → 204
POST
/uploads/{upl_id}/file
Upload file
upload_file 1 param body → 202422
POST
/uploads/{upl_id}/exports
Create Export
upload_export_create 1 param body → 2004XX
GET
/uploads/{upl_id}/report
Retrieve Line Item Report
report_retrieve 4 params → 200404
GET
/uploads/{upl_id}/exports/{ex_id}
Retrieve Export
export_retrieve 2 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are upload_writable (5 properties), upload_updatable (5 properties), required_address_column_mapping (5 properties), optional_address_column_mapping (3 properties). Each schema is shown below with its type and property counts.

count
integer
number of resources in a set
uploads_metadata
object
The list of column headers in your file as an array that you want as metadata associated with each mailpiece. See our Campaign Audience Guide for additional de…
1 property 1 required
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…
upload_file
object
2 properties 2 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 property 1 required
upload_state
string
The state property on the upload object. As the file is processed, the state will change from Ready for Validation to Validating and then will be either Schedu…
optional_address_column_mapping
object
The mapping of column headers in your file to Lob-optional fields for the resource created. See our Campaign Audience Guide for additional details.
3 properties 3 required
upload_writable
object
5 properties 1 required
upload
ex_id
string
Unique identifier prefixed with ex.
upl_id
string
Unique identifier prefixed with upl.
upload_create_export
object
2 properties 2 required
cmp_id
string
Unique identifier prefixed with cmp.
merge_variable_column_mapping
objectnull
The mapping of column headers in your file to the merge variables present in your creative. See our Campaign Audience Guide for additional details. If a merge…
required_address_column_mapping
object
The mapping of column headers in your file to Lob-required fields for the resource created. See our Campaign Audience Guide for additional details.
5 properties 5 required
upload_updatable
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lob-uploads-api-openapi.yml Raw ↑

Other APIs Lob publishes across the network.

Lob Accounts API
AE Profile APIs.io
Lob Addresses API
AE Profile APIs.io
Lob Bank Accounts API
AE Profile APIs.io
Lob Bank_id API
AE Profile APIs.io
Lob Bg_id API
AE Profile APIs.io
Lob Billing Groups API
AE Profile APIs.io
Lob Booklet_id API
AE Profile APIs.io
Lob Booklets API
AE Profile APIs.io
Lob Buckslip_id API
AE Profile APIs.io
Lob Buckslips API
AE Profile APIs.io
Lob Bulk API
AE Profile APIs.io
Lob Campaigns API
AE Profile APIs.io
#Uploads
← Back to L APIs
API Details
ID
lob:lob-uploads-api
Server
https://api.lob.com/v1
Docs
https://docs.lob.com/
Provider
Lob
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lob-uploads-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lob-uploads-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Uploads 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.