The campaigns endpoint allows you to create and view campaigns that can be used to send multiple letters or postcards.The API provides endpoints for creating campaigns, updating campaigns, retrieving individual campaigns, listing campaigns, and deletingcampaigns.
Lob.com Campaigns API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Campaigns 6
The campaigns endpoint allows you to create and view campaigns that can be used to send multiple letters or postcards. The API provides endpoints for creating campaigns, updating…
GET
/campaigns
List
campaigns_list3 params→ 200
POST
/campaigns
Create
campaign_create1 parambody→ 200default
GET
/campaigns/{cmp_id}
Retrieve
campaign_retrieve1 param→ 200default
PATCH
/campaigns/{cmp_id}
Update
campaign_update1 parambody→ 200default
DELETE
/campaigns/{cmp_id}
Delete
campaign_delete1 param→ 200default
POST
/campaigns/{cmp_id}/send
Send Campaign
campaign_send1 param→ 200default
Schemas 51
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are campaign_writable (11 properties), campaign_updatable (10 properties), returned-3 (9 properties), address_fields_us (5 properties). Each schema is shown below with its type and property counts.
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 properties3 required
card_id
string
Unique identifier prefixed with card.
extra_service
stringnull
Add an extra service to your letter. Can only be non-null if mailtype isn't uspsstandard. See pricing for extra costs incurred. certified - track and confirm d…
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
crv_id
string
Unique identifier prefixed with crv.
returned-4
object
Properties that the self mailers in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
4 properties
double_sided
boolean
Set this attribute to true for double sided printing, or false for for single sided printing. Defaults to true.
upload
count
integer
number of resources in a set
upl_id
string
Unique identifier prefixed with upl.
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…
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…
campaign_list
array
Array of campaigns associated with the creative ID
creative_base
object
3 properties
color
boolean
Set this key to true if you would like to print in color. Set to false if you would like to print in black and white.
campaign_item
lob_base
object
4 properties3 required
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…
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…
cmp_schedule_type
string
How the campaign should be scheduled. Only value available today is immediate.
returned_resource
adr_id
string
Unique identifier prefixed with adr.
postcard_size
string
Specifies the size of the postcard. Only 4x6 postcards can be sent to international destinations.
campaign
buckslip_id
string
Unique identifier prefixed with bck.
address_placement
string
Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our l…
date_created
string
A timestamp in ISO 8601 format of the date the resource was created.
list
object
Multiple items returned in order
5 properties
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 property1 required
resource_description
stringnull
An internal description that identifies this resource. Must be no longer than 255 characters.
inline_address_us
address_editable_us
creative
campaign_writable
object
11 properties3 required
print_speed
stringnull
A string designating the mail speed type: core - 2 production business days
date_modified
string
A timestamp in ISO 8601 format of the date the resource was last modified.
address_fields_us
object
5 properties4 required
returned-3
object
Properties that the letters in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
9 properties
returned
object
Properties that the postcards in your Creative should have. See the qrcode attribute below to add a QR code to your creative.
4 properties
campaign_updatable
object
10 properties
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…
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 properties5 required
from_attribute
Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by v…
deleted
boolean
Only returned if the resource has been successfully deleted.
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.
cmp_id
string
Unique identifier prefixed with cmp.
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…
object
string
Value is resource type.
upload_writable
object
5 properties1 required
cmp_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…
returned-2
objectnull
A nested custom envelope object containing more information about the custom envelope used or null if a custom envelope was not used.
3 properties3 required
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.com Campaigns 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.
