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 deleting campaigns.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/lobcom-campaigns-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Lob Campaigns 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: Campaigns
description: '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 deleting
campaigns.
'
paths:
/campaigns:
get:
operationId: campaigns_list
summary: List
description: Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first.
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/before_after'
responses:
'200':
$ref: '#/components/responses/all_campaigns'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/campaigns \\\n -u <YOUR API KEY>:\n"
label: CURL
- lang: Ruby
source: "campaignsApi = CampaignsApi.new(config)\n\nbegin\n campaigns = campaignsApi.list({ limit: 2 })\nrescue => err\n p err.message\nend\n"
label: RUBY
post:
operationId: campaign_create
summary: Create
description: Creates a new campaign with the provided properties. See how to launch your first campaign [here](https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/launch-your-first-campaign).
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/lang_spec'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/campaign_writable'
example:
name: My Demo Campaign
description: My Campaign's description
schedule_type: immediate
print_speed: core
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/campaign_writable'
encoding:
example-prop:
style: deepObject
explode: true
example:
name: My Demo Campaign
description: My Campaign's description
schedule_type: immediate
print_speed: core
multipart/form-data:
schema:
$ref: '#/components/schemas/campaign_writable'
example:
name: My Demo Campaign
description: My Campaign's description
schedule_type: immediate
print_speed: core
responses:
'200':
description: Campaign created successfully
content:
$ref: '#/components/mediaTypes/campaign'
default:
$ref: '#/components/responses/campaigns_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/campaigns \\\n -u <YOUR API KEY>: \\\n -d \"name=My First Campaign\" \\\n -d \"schedule_type=immediate\" \\\n -d \"print_speed=core\"\n"
label: CURL
- lang: Ruby
source: "campaignCreate = CampaignWritable.new({\n name: \"My First Campaign\",\n schedule_type: \"immediate\",\n print_speed: \"core\",\n});\n\ncampaignApi = CampaignsApi.new(config)\n\nbegin\n createdCampaign = campaignApi.create(campaignCreate)\nrescue => err\n p err.message\nend\n"
label: RUBY
/campaigns/{cmp_id}:
parameters:
- in: path
name: cmp_id
description: id of the campaign
required: true
schema:
$ref: '#/components/schemas/cmp_id'
get:
operationId: campaign_retrieve
summary: Retrieve
description: Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.
tags:
- Campaigns
responses:
'200':
description: Returns a campaign object
content:
$ref: '#/components/mediaTypes/campaign'
default:
$ref: '#/components/responses/campaigns_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \\\n -u <YOUR API KEY>:\n"
label: CURL
- lang: Ruby
source: "campaignApi = CampaignsApi.new(config)\n\nbegin\n retrievedCampaign = campaignApi.get(\"cmp_e05ee61ff80764b\")\nrescue => err\n p err.message\nend\n"
label: RUBY
patch:
operationId: campaign_update
summary: Update
description: Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation.
tags:
- Campaigns
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/campaign_updatable'
example:
description: Test campaign
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/campaign_updatable'
example:
description: Test campaign
multipart/form-data:
schema:
$ref: '#/components/schemas/campaign_updatable'
example:
description: Test campaign
responses:
'200':
description: Returns a campaign object
content:
$ref: '#/components/mediaTypes/campaign'
default:
$ref: '#/components/responses/campaigns_error'
x-codeSamples:
- lang: Shell
source: "curl -X PATCH https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \\\n -u <YOUR API KEY>: \\\n -d \"description=Awesome campaign\"\n"
label: CURL
- lang: Python
source: "campaign_updatable = CampaignUpdatable(\n description = \"Awesome campaign\",\n)\n\nwith ApiClient(configuration) as api_client:\n api = CampaignsApi(api_client)\n\ntry:\n updated_campaign = api.update(\"cmp_e05ee61ff80764b\", campaign_updatable)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: Ruby
source: "campaignUpdatable = CampaignUpdatable.new({\n description: \"Awesome campaign\",\n})\n\ncampaignApi = CampaignsApi.new(config)\n\nbegin\n updatedCampaign = campaignApi.update(\"cmp_e05ee61ff80764b\", campaignUpdatable)\nrescue => err\n p err.message\nend\n"
label: RUBY
delete:
operationId: campaign_delete
summary: Delete
description: Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's `send_date` matches its associated mail pieces' `send_date`s.
tags:
- Campaigns
responses:
'200':
$ref: '#/components/responses/campaign_deleted'
default:
$ref: '#/components/responses/campaigns_error'
x-codeSamples:
- lang: Shell
source: "curl -X DELETE https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \\\n -u <YOUR API KEY>:\n"
label: CURL
- lang: Ruby
source: "campaignApi = CampaignsApi.new(config)\n\nbegin\n deletedCampaign = campaignApi.delete(\"cmp_e05ee61ff80764b\")\nrescue => err\n p err.message\nend\n"
label: RUBY
/campaigns/{cmp_id}/send:
parameters:
- in: path
name: cmp_id
description: id of the campaign
required: true
schema:
$ref: '#/components/schemas/cmp_id'
post:
operationId: campaign_send
summary: Send Campaign
description: Sends a campaign. You need only supply the unique campaign identifier that was returned upon campaign creation.
tags:
- Campaigns
responses:
'200':
description: Returns a campaign object
content:
$ref: '#/components/mediaTypes/campaign'
default:
$ref: '#/components/responses/campaigns_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b/send \\\n -u <YOUR API KEY>:\n"
label: CURL
components:
parameters:
lang_spec:
in: header
name: x-lang-output
required: false
description: '* `native` - Translate response to the native language of the country in the request
* `match` - match the response to the language in the request
Default response is in English.
'
schema:
type: string
enum:
- native
- match
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
limit:
in: query
name: limit
required: false
description: How many results to return.
schema:
type: integer
minimum: 1
default: 10
maximum: 100
example: 10
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
schemas:
optional_address_column_mapping:
title: Optional Address Columns
type: object
required:
- address_line2
- company
- address_country
properties:
address_line2:
type:
- string
- 'null'
default: null
description: The column header from the csv file that should be mapped to the optional field "address_line2"
company:
type:
- string
- 'null'
default: null
description: The column header from the csv file that should be mapped to the optional field "company"
address_country:
type:
- string
- 'null'
default: null
description: The column header from the csv file that should be mapped to the optional field "address_country"
example:
address_line2: secondary_line
company: company
address_country: country,
description: The mapping of column headers in your file to Lob-optional fields for the resource created. See our <a href="https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#optional-columns-3" target="_blank">Campaign Audience Guide</a> for additional details.
card_id:
type: string
description: Unique identifier prefixed with `card_`.
pattern: ^card_[a-zA-Z0-9]+$
extra_service:
type:
- string
- 'null'
enum:
- certified
- certified_return_receipt
- registered
- null
description: "Add an extra service to your letter. Can only be non-`null` if `mail_type` isn't `usps_standard`. See <a href=\"https://www.lob.com/pricing/print-mail#compare\" target=\"_blank\">pricing</a> for extra costs incurred.\n * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf\" target=\"_blank\">#10 envelope</a> and <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf\" target=\"_blank\">flat envelope</a> (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.\n * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter\n * `registered` - provides tracking and confirmation for international addresses\n \nNot available for `us_legal` letter size.\n"
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
- file_size_exceeds_limit
- foreign_return_address
- inconsistent_page_dimensions
- invalid_bank_account
- invalid_bank_account_verification
- invalid_check_international
- invalid_country_covid
- invalid_file
- invalid_file_dimensions
- invalid_file_download_time
- invalid_file_url
- invalid_image_dpi
- invalid_international_feature
- invalid_perforation_return_envelope
- invalid_template_html
- mail_use_type_can_not_be_null
- merge_variable_required
- merge_variable_whitespace
- payment_method_unverified
- pdf_encrypted
- special_characters_restricted
- unembedded_fonts
- email_required
- invalid_api_key
- publishable_key_not_allowed
- rate_limit_exceeded
- unauthorized
- unauthorized_token
description: 'A pre-defined string identifying an error. Error codes fall into three categories:
**GENERIC**
* `bad_request` - 422: an invalid request was made. See error message for details.
* `conflict` - 409/422: this operation would leave data in a conflicted state.
* `feature_limit_reached` - 403: the account has reached its resource limit and requires upgrading to add more.
* `internal_server_error` - 500: an error has occured on Lob''s servers. Please try request again.
* `invalid` - 422: an invalid request was made. See error message for details.
* `not_deletable` - 422: an attempt was made to delete a resource, but the resource cannot be deleted.
* `not_found` - 404: the requested resource was not found.
* `request_timeout` - 408: the request took too long. Please try again.
* `service_unavailable` - 503: the Lob servers are temporarily unavailable. Please try agian.
* `unrecognized_endpoint` - 404: the requested endpoint doesn''t exist.
* `unsupported_lob_version` - 422: an unsupported Lob API version was requested.
**ADVANCED**
* `address_length_exceeds_limit` - 422: the sum of to.address_line1 and to.address_line2 cannot surpass 50 characters.
* `bank_account_already_verified` - 422: the bank account has already been verified.
* `bank_error` - 422: there''s an issue with the bank account.
* `billing_address_required` - 403: in order to create a live mail piece, your account needs to set up a billing address.
* `custom_envelope_inventory_depleted` - 422: custom envelope inventory is depleted, and more will need to be ordered.
* `deleted_bank_account` - 404: checks cannot be created with a deleted bank account.
* `failed_deliverability_strictness` - 422: the `to` address doesn''t meet strictness requirements. See <a href="https://dashboard.lob.com/#/settings/account" target="_blank">Account Settings</a> to configure strictness.
* `file_pages_below_min` - 422: not enough pages.
* `file_pages_exceed_max` - 422: too many pages.
* `file_size_exceeds_limit` - 422: the file size is too large. See description for details.
* `foreign_return_address` - 422: the `from` address must be a US address.
* `inconsistent_page_dimensions` - 422: all pages of the input file must have the same dimensions.
* `invalid_bank_account` - 422: the provided bank routing number is invalid.
* `invalid_bank_account_verification` - 422: verification amounts do not match.
* `invalid_check_international` - 422: checks cannot be sent internationally.
* `invalid_country_covid` - 422: the postal service in the specified country is currently unable to process the request due to COVID-19 restrictions.
* `invalid_file` - 422: the file is invalid.
* `invalid_file_dimensions` - 422: file dimensions are incorrect for the selected mail type.
* `invalid_file_download_time` - 422: file download from remote server took too long.
* `invalid_file_url` - 422: the file URL when creating a resource is invalid.
* `invalid_image_dpi` - 422: DPI must be at least 300.
* `invalid_international_feature` - 422: the specified product cannot be sent to the destination.
* `invalid_perforation_return_envelope` - 422: both `return_envelope` and `perforation` must be used together.
* `invalid_template_html` - 422: the provided HTML is invalid.
* `mail_use_type_can_not_be_null` - 422: use_type must be one of "marketing" or "operational". Alternatively, an admin can set the account default use type in Account Settings.
* `merge_variable_required` - 422: a required merge variable is missing.
* `merge_variable_whitespace` - 422: merge variable names cannot contain whitespace.
* `payment_method_unverified` - 401: you must have a verified bank account or credit card to submit live requests.
* `pdf_encrypted` - 422: an encrypted PDF was provided.
* `special_characters_restricted` - 422: cannot use special characters for merge variable names.
* `unembedded_fonts` - 422: the provided PDF contains non-standard unembedded fonts. See description for details.
**AUTHENTICATION**
* `email_required` - 401: account must have a verified email address before creating live resources.
* `invalid_api_key` - 401/403: the API key is invalid.
* `publishable_key_not_allowed` - 403: the requested operation needs a secret key, not a publishable key. See [API Keys](#section/API-Keys) for more information.
* `rate_limit_exceeded` - 429: requests were sent too quickly and must be slowed down.
* `unauthorized` - 401: the request isn''t authorized.
* `unauthorized_token` - 401: token isn''t authorized.
'
crv_id:
type: string
description: Unique identifier prefixed with `crv_`.
pattern: ^crv_[a-zA-Z0-9]+$
example: crv_2a3b096c409b32c
returned-4:
description: Properties that the self mailers in your Creative should have. See the `qr_code` attribute below to add a QR code to your creative.
properties:
mail_type:
$ref: '#/components/schemas/mail_type'
size:
$ref: '#/components/schemas/self_mailer_size'
inside_original_url:
description: The original URL of the `inside` template.
maxLength: 2083
minLength: 1
type: string
format: uri
outside_original_url:
description: The original URL of the `outside` template.
maxLength: 2083
minLength: 1
type: string
format: uri
double_sided:
type: boolean
description: Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`.
default: true
upload:
allOf:
- $ref: '#/components/schemas/upload_writable'
- type: object
required:
- id
- accountId
- campaignId
- requiredAddressColumnMapping
- optionalAddressColumnMapping
- metadata
- mergeVariableColumnMapping
- mode
- state
- totalMailpieces
- failedMailpieces
- validatedMailpieces
- bytesProcessed
- dateCreated
- dateModified
properties:
id:
$ref: '#/components/schemas/upl_id'
accountId:
title: Account ID
type: string
description: Account ID that made the request
example: fa9ea650fc7b31a89f92
mode:
enum:
- test
- live
type: string
description: The environment in which the mailpieces were created. Today, will only be `live`.
failuresUrl:
title: Failures URL
type: string
example: https://www.example.com
description: Url where your campaign mailpiece failures can be retrieved
originalFilename:
title: Original Filename
type: string
example: my_audience.csv
description: Filename of the upload
state:
$ref: '#/components/schemas/upload_state'
totalMailpieces:
title: Total Mailpieces
type: integer
example: 100
description: Total number of recipients for the campaign
failedMailpieces:
title: Failed Mailpieces
type: integer
example: 5
description: Number of mailpieces that failed to create
validatedMailpieces:
title: Validated Mailpieces
type: integer
example: 95
description: Number of mailpieces that were successfully created
bytesProcessed:
title: Bytes Processed
type: integer
example: 17268
description: Number of bytes processed in your CSV
dateCreated:
title: Date Created
type: string
format: date-time
description: A timestamp in ISO 8601 format of the date the upload was created
dateModified:
title: Date Modified
type: string
format: date-time
description: A timestamp in ISO 8601 format of the date the upload was last modified
count:
type: integer
description: number of resources in a set
upl_id:
type: string
description: Unique identifier prefixed with `upl_`.
pattern: ^upl_[a-zA-Z0-9]+$
merge_variable_column_mapping:
title: Merge Variable Mapping
type:
- object
- 'null'
default: null
example:
name: recipient_name
gift_code: code
qr_code_redirect_url: redirect_url
description: The mapping of column headers in your file to the merge variables present in your creative. See our <a href="https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7" target="_blank">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same "name" as a "key" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects. The redirect URLs for QR codes can also be customized using this mapping. If the URL has a variable and the variable mapping existsing here, then data from the respective column in the audience file will be merged into the URL template.
company:
type:
- string
- 'null'
description: '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 two separate lines above the rest of the address. This field can be used for any secondary recipient information which is not part of the actual mailing address (Company Name, Department, Attention Line, etc).
'
maxLength: 40
campaign_list:
type: array
description: Array of campaigns associated with the creative ID
items:
$ref: '#/components/schemas/campaign_item'
example:
- id: cmp_ed76e33e7ac4d0bd
name: My postman Campaign 2
description: Created via postman again
schedule_type: immediate
send_date: null
target_delivery_date: null
cancel_window_campaign_minutes: null
metadata: {}
use_type: null
is_draft: true
deleted: false
creatives: []
uploads: []
auto_cancel_if_ncoa: false
date_created: '2022-07-26T20:20:25.016Z'
date_modified: '2022-07-26T20:20:25.016Z'
object: campaign
creative_base:
type: object
properties:
from:
$ref: '#/components/schemas/from_attribute'
description:
$ref: '#/components/schemas/resource_description'
metadata:
$ref: '#/components/schemas/metadata'
color:
type: boolean
description: 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:
allOf:
- $ref: '#/components/schemas/campaign_writable'
- type: object
required:
- id
- name
- description
- schedule_type
- use_type
- is_draft
- creatives
- uploads
- auto_cancel_if_ncoa
- date_created
- date_modified
- object
properties:
id:
$ref: '#/components/schemas/cmp_id'
is_draft:
description: Whether or not the campaign is still a draft.
type: boolean
default: true
creatives:
description: An array of creatives that have been associated with this campaign.
type: array
uploads:
description: A single-element array containing the upload object that is assocated with this campaign.
type: array
minItems: 0
maxItems: 1
object:
type: string
description: Value is resource type.
enum:
- campaign
default: campaign
date_created:
$ref: '#/components/schemas/date_created'
date_modified:
$ref: '#/components/schemas/date_modified'
deleted:
$ref: '#/components/schemas/deleted'
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'
metadata:
type: object
additionalProperties:
type: string
description: '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 at most 40 characters and values must be at most 500 characters. Neither can contain the characters `"` and `\`. i.e. ''{"customer_id" : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.'
maxLength: 500
pattern: '[^"\\]{0,500}'
failure_status_code:
type: integer
enum:
- 401
- 403
- 404
- 413
- 422
- 429
- 500
description: "A conventional HTTP status code:\n * `401` - Authorization error with your API key or account\n * `403` - Forbidden error with your API key or account\n * `404` - The requested item does not exist\n * `413` - Payload too large\n * `422` - The query or body parameters did not pass validation\n * `429` - Too many requests have been sent with an API key in a given amount of time\n * `500` - An internal server error occurred, please contact support@lob.com\n"
cmp_schedule_type:
description: How the campaign should be scheduled. Only value available today is `immediate`.
type: string
enum:
- immediate
returned_resource:
oneOf:
- allOf:
- title: Postcard Creative
required:
- resource_type
- details
properties:
resource_type:
type: string
description: Mailpiece type for the creative
enum:
- postcard
details:
$ref: '#/components/schemas/returned'
- $ref: '#/components/schemas/creative_base'
- allOf:
- title: Letter Creative
required:
- from
- resource_type
- details
properties:
resource_type:
type: string
description: Mailpiece type for the creative
enum:
- letter
details:
$ref: '#/components/schemas/returned-3'
- $ref: '#/components/schemas/creative_base'
- allOf:
- title: Self Mailer Creative
required:
- resource_type
- details
properties:
resource_type:
type: string
description: Mailpiece type for the creative
enum:
- self_mailer
details:
$ref: '#/components/schemas/returned-4'
- $ref: '#/components/schemas/creative_base'
adr_id:
type: string
description: Unique identifier prefixed with `adr_`.
pattern: ^adr_[a-zA-Z0-9]+$
postcard_size:
type: string
enum:
- 4x6
- 6x9
- 6x11
description: 'Specifies the size of the postcard. Only `4
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lobcom/refs/heads/main/openapi/lobcom-campaigns-api-openapi.yml