The Lob connector lets your AI agent act in each user's Lob account. Each user connects their own Lob API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 63 tools.
- Tools
- 63
- What they doRead · write · destructive
- 31 · 21 · 1131 read21 write11 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Lob connection
In AgentKit > Connections, create a Lob connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toollob_autocomplete_us_addressSuggest US street addresses that match a typed prefix, optionally filtered by city, state or ZIP.Read-onlyAutocomplete US Address
Suggest US street addresses that match a typed prefix, optionally filtered by city, state or ZIP. Returns an object with `suggestions`, each holding a `primary_line`, `city`, `state` and `zip_code`. Use autocomplete_us_address for type-ahead address entry. Use verify_us_address to confirm a full address.
Inputs
address_prefixstringrequired- Street number and street name typed so far, alphanumeric only. Example: `210 King`.
casestring- Casing of suggestions: `upper` (default) or `proper`.one of
upperproper citystring- City to filter suggestions by. Case insensitive; partial names do not match.
statestring- State to filter suggestions by. Case insensitive.
valid_addresses_onlyboolean- If true, every suggestion is a valid deliverable address. If false (default), suggestions may need verification.
zip_codestring- ZIP code to filter suggestions by. Partial entries match.
lob_get_addressRetrieve one saved address by ID.Read-onlyGet Address
Retrieve one saved address by ID. Returns the address record with name, company, address lines, city, state, zip, country and metadata. Use get_address when you already have an `adr_` ID. Use list_addresses to browse.
Inputs
address_idstringrequired- ID of the address, prefixed with `adr_`.
lob_get_bank_accountRetrieve one bank account by ID.Read-onlyGet Bank Account
Retrieve one bank account by ID. Returns the bank account with `id`, masked `account_number`, `routing_number`, `signatory` and `verified`. Use get_bank_account to check verification status before creating a check.
Inputs
bank_account_idstringrequired- ID of the bank account, prefixed with `bank_`.
lob_get_billing_groupRetrieve one billing group by ID.Read-onlyGet Billing Group
Retrieve one billing group by ID. Returns the billing group with `id`, `name`, `description` and dates. Use get_billing_group when you have a `bg_` ID.
Inputs
billing_group_idstringrequired- ID of the billing group, prefixed with `bg_`.
lob_get_campaignRetrieve one campaign by ID.Read-onlyGet Campaign
Retrieve one campaign by ID. Returns the campaign with `id`, `name`, `schedule_type`, `is_draft`, `creatives` and `uploads`. Use get_campaign to inspect a campaign's state before sending it.
Inputs
campaign_idstringrequired- ID of the campaign, prefixed with `cmp_`.
lob_get_checkRetrieve one check by ID, including tracking events.Read-onlyGet Check
Retrieve one check by ID, including tracking events. Returns the check record with `to`, `from`, `amount`, `bank_account`, `check_number`, `send_date`, `expected_delivery_date`, `tracking_events` and `url`. Use get_check to see the status of a check you created.
Inputs
check_idstringrequired- ID of the check, prefixed with `chk_`.
lob_get_creativeRetrieve one campaign creative by ID.Read-onlyGet Creative
Retrieve one campaign creative by ID. Returns the creative with `id`, `resource_type`, `details`, `template_preview_urls` and `campaigns`. Use get_creative to inspect or preview a creative.
Inputs
creative_idstringrequired- ID of the creative, prefixed with `crv_`.
lob_get_credits_balanceRetrieve the Lob credits balance of the account.Read-onlyGet Credits Balance
Retrieve the Lob credits balance of the account. Returns an object with the `balance` of Lob credits. Use get_credits_balance to check available credits before a large mailing.
Inputs
This tool takes no inputs.
lob_get_domainRetrieve one registered short-link domain by ID.Read-onlyGet Domain
Retrieve one registered short-link domain by ID. Returns the domain with `id`, `domain`, `status` and dates. Use get_domain to check a domain's configuration status.
Inputs
domain_idstringrequired- ID of the domain, prefixed with `dom_`.
lob_get_letterRetrieve one letter by ID, including tracking events.Read-onlyGet Letter
Retrieve one letter by ID, including tracking events. Returns the letter record with `to`, `from`, `color`, `send_date`, `expected_delivery_date`, `tracking_events`, `thumbnails` and `url`. Use get_letter to check the status of a letter you created.
Inputs
letter_idstringrequired- ID of the letter, prefixed with `ltr_`.
lob_get_linkRetrieve one short link by ID.Read-onlyGet Short Link
Retrieve one short link by ID. Returns the link with `id`, `short_link`, `redirect_link`, `title` and `metadata`. Use get_link when you have a link ID.
Inputs
link_idstringrequired- ID of the short link, prefixed with `link_`.
lob_get_postcardRetrieve one postcard by ID, including tracking events.Read-onlyGet Postcard
Retrieve one postcard by ID, including tracking events. Returns the postcard record with `to`, `from`, `size`, `send_date`, `expected_delivery_date`, `tracking_events`, `thumbnails` and `url`. Use get_postcard to check the status of a postcard you created.
Inputs
postcard_idstringrequired- ID of the postcard, prefixed with `psc_`.
lob_get_self_mailerRetrieve one self mailer by ID, including tracking events.Read-onlyGet Self Mailer
Retrieve one self mailer by ID, including tracking events. Returns the self mailer record with `to`, `from`, `size`, `send_date`, `expected_delivery_date`, `tracking_events` and `url`. Use get_self_mailer to check a self mailer you created.
Inputs
self_mailer_idstringrequired- ID of the self mailer, prefixed with `sfm_`.
lob_get_templateRetrieve one template by ID, with its published version and version list.Read-onlyGet Template
Retrieve one template by ID, with its published version and version list. Returns the template with `id`, `description`, `published_version`, `versions` and `metadata`. Use get_template for a single template. Use list_templates to browse.
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
lob_get_template_versionRetrieve one version of a template, including its HTML.Read-onlyGet Template Version
Retrieve one version of a template, including its HTML. Returns the version with `id`, `html`, `engine`, `required_vars` and `description`. Use get_template_version to read a version's HTML. Use get_template for the template and its published version.
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
version_idstringrequired- ID of the template version, prefixed with `vrsn_`.
lob_list_addressesList saved addresses in the address book, newest first.Read-onlyList Addresses
List saved addresses in the address book, newest first. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_addresses to browse the address book. Use get_address to fetch one saved address by ID.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_list_bank_accountsList bank accounts used to pay checks, newest first.Read-onlyList Bank Accounts
List bank accounts used to pay checks, newest first. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_bank_accounts to find the bank account to draw a check on.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_list_billing_groupsList billing groups used to tag mailing usage.Read-onlyList Billing Groups
List billing groups used to tag mailing usage. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_billing_groups to find a billing group ID. Billing groups require activation on your Lob account.
Inputs
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 offsetinteger- Number of results to skip, for offset paging. Defaults to 0.default
0
lob_list_campaignsList print-and-mail campaigns, newest first.Read-onlyList Campaigns
List print-and-mail campaigns, newest first. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_campaigns to browse campaigns. Use get_campaign for one campaign.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_list_checksList checks, newest first, optionally filtered by status or scheduling.Read-onlyList Checks
List checks, newest first, optionally filtered by status or scheduling. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_checks to browse or filter sent checks. Use get_check for one record.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard scheduledboolean- `true` returns only pieces with a future or past scheduled send_date; `false` only those sent immediately.
sort_directionstring- Sort direction on `date_created`: `asc` for oldest first or `desc` for newest first.one of
ascdesc statusstring- Filter by render status: `processed` (rendering underway), `rendered` (finished) or `failed`.one of
processedrenderedfailed
lob_list_domainsList custom domains registered for short links.Read-onlyList Domains
List custom domains registered for short links. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_domains to see custom short-link domains and their configuration status.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 statusstring- Filter by configuration status: `configured` or `not_configured`.one of
configurednot_configured
lob_list_lettersList letters, newest first, optionally filtered by status, color, mail type or campaign.Read-onlyList Letters
List letters, newest first, optionally filtered by status, color, mail type or campaign. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_letters to browse or filter sent letters. Use get_letter for one record.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
campaign_idstring- Only return resources created by this campaign (ID starts with `cmp_`).
colorboolean- `true` returns only color letters; `false` only black and white letters.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard scheduledboolean- `true` returns only pieces with a future or past scheduled send_date; `false` only those sent immediately.
sort_directionstring- Sort direction on `date_created`: `asc` for oldest first or `desc` for newest first.one of
ascdesc statusstring- Filter by render status: `processed` (rendering underway), `rendered` (finished) or `failed`.one of
processedrenderedfailed
lob_list_linksList shortened tracking links created for QR codes and mailpieces.Read-onlyList Short Links
List shortened tracking links created for QR codes and mailpieces. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_links to browse short links, optionally by campaign or domain. Use get_link for one link.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
campaign_idstring- Only return resources created by this campaign (ID starts with `cmp_`).
domain_idstring- Only return links on this registered domain ID.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_list_postcardsList postcards, newest first, optionally filtered by status, size, mail type or campaign.Read-onlyList Postcards
List postcards, newest first, optionally filtered by status, size, mail type or campaign. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_postcards to browse or filter sent postcards. Use get_postcard for one record.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
campaign_idstring- Only return resources created by this campaign (ID starts with `cmp_`).
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard scheduledboolean- `true` returns only pieces with a future or past scheduled send_date; `false` only those sent immediately.
sizestring- Only return postcards of this size: `4x6`, `6x9` or `6x11`.one of
4x66x96x11 sort_directionstring- Sort direction on `date_created`: `asc` for oldest first or `desc` for newest first.one of
ascdesc statusstring- Filter by render status: `processed` (rendering underway), `rendered` (finished) or `failed`.one of
processedrenderedfailed
lob_list_self_mailersList self mailers, newest first, optionally filtered by status, size, mail type or campaign.Read-onlyList Self Mailers
List self mailers, newest first, optionally filtered by status, size, mail type or campaign. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_self_mailers to browse or filter sent self mailers. Use get_self_mailer for one record.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
campaign_idstring- Only return resources created by this campaign (ID starts with `cmp_`).
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10 mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard scheduledboolean- `true` returns only pieces with a future or past scheduled send_date; `false` only those sent immediately.
sizestring- Only return self mailers of this size.one of
6x18_bifold11x9_bifold12x9_bifold17.75x9_trifold sort_directionstring- Sort direction on `date_created`: `asc` for oldest first or `desc` for newest first.one of
ascdesc statusstring- Filter by render status: `processed` (rendering underway), `rendered` (finished) or `failed`.one of
processedrenderedfailed
lob_list_template_versionsList the versions of one template.Read-onlyList Template Versions
List the versions of one template. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_template_versions to see a template's revisions. Use get_template_version for one version's HTML.
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_list_templatesList HTML templates, newest first.Read-onlyList Templates
List HTML templates, newest first. Returns a list object with `data` (array of matching records), `count`, `total_count`, `next_url` and `previous_url` for paging. Use list_templates to find reusable artwork. Use get_template for one template including its versions.
Inputs
afterstring- Pagination cursor taken from the `next_url` of a previous list response (its `after` query value). Do not combine with `before`.
beforestring- Pagination cursor taken from the `previous_url` of a previous list response. Do not combine with `after`.
created_afterstring- Only return resources created after this ISO 8601 date or datetime.
created_beforestring- Only return resources created before this ISO 8601 date or datetime.
limitinteger- Number of results to return per page, from 1 to 100. Defaults to 10.default
10
lob_lookup_zip_codeLook up the cities and state that belong to a 5-digit US ZIP code.Read-onlyLook Up ZIP Code
Look up the cities and state that belong to a 5-digit US ZIP code. Returns an object with `zip_code`, `zip_code_type` and `cities` (each with city name, state and preferred flag). Use lookup_zip_code to resolve a ZIP into city and state. Use verify_us_address to validate a full address.
Inputs
zip_codestringrequired- A 5-digit US ZIP code.
lob_reverse_geocodeFind the US addresses closest to a latitude and longitude.Read-onlyReverse Geocode Location
Find the US addresses closest to a latitude and longitude. Returns an object with `addresses`, each a verified US address with components and the distance from the point. Use reverse_geocode to turn coordinates into mailable US addresses.
Inputs
latitudenumberrequired- Latitude in decimal degrees, from -90 to 90.
longitudenumberrequired- Longitude in decimal degrees, from -180 to 180.
sizeinteger- Number of locations to return, 1 to 50. Defaults to 5.default
5
lob_verify_intl_addressVerify an address outside the US and return it in a standardized format.Read-onlyVerify International Address
Verify an address outside the US and return it in a standardized format. Returns the standardized address lines, `deliverability`, `status`, `coverage` and parsed `components`. Use verify_intl_address for non-US addresses. Use verify_us_address for US addresses. Provide either `address` as a freeform string, or `primary_line` with the other fields. `country` is always required.
Inputs
countrystringrequired- Two-letter ISO 3166 country code of the address.
addressstring- The whole address as one freeform string, used instead of the separate fields.
citystring- City of the address.
postal_codestring- Postal code of the address.
primary_linestring- Street line of the address. Required unless `address` is given.
recipientstring- Name of the recipient or company.
secondary_linestring- Second address line such as unit or suite.
statestring- State, province or region.
lob_verify_us_addressVerify and standardize a US address, checking it against USPS data.Read-onlyVerify US Address
Verify and standardize a US address, checking it against USPS data. Returns the standardized address lines, `deliverability` (deliverable, deliverable_unnecessary_unit, deliverable_incorrect_unit, deliverable_missing_unit or undeliverable), `valid_address` and parsed `components`. Use verify_us_address before mailing to a US address. Use verify_intl_address for non-US addresses and autocomplete_us_address to suggest completions as a user types. Provide either `address` as one freeform line, or `primary_line` with `city`, `state` and `zip_code`.
Inputs
addressstring- The whole address as one freeform string, used instead of the separate fields. Example: `210 King St San Francisco CA 94107`.
casestring- Casing of the returned address: `upper` (default) or `proper`.one of
upperproper citystring- City. Required with `primary_line` unless a `zip_code` is given.
primary_linestring- Street line of the address (number and street, or PO box). Required unless `address` is given.
recipientstring- Name of the recipient or company.
secondary_linestring- Apartment, suite or unit line.
statestring- Two-letter state code. Required with `primary_line` unless a `zip_code` is given.
urbanizationstring- Urbanization code, used for Puerto Rico addresses only.
zip_codestring- 5 or 9 digit ZIP code. Required with `primary_line` unless city and state are given.
lob_create_addressSave a new address in the address book so it can be reused as a sender or recipient.WriteCreate Address
Save a new address in the address book so it can be reused as a sender or recipient. Returns the saved address with its `id` (starts with `adr_`) and normalized fields. Use create_address to store an address for reuse. Use verify_us_address to check deliverability first; this tool does not verify.
Inputs
address_line1stringrequired- First line of the street address.
address_citystring- City. Required for US addresses.
address_countrystring- Two-letter ISO 3166 country code. Defaults to `US`. Required for non-US addresses.
address_line2string- Second line of the address, such as suite or unit.
address_statestring- Two-letter state code for US addresses, or the province or region elsewhere. Required for US addresses.
address_zipstring- ZIP code. Required for US addresses.
companystring- Company name. Required if `name` is not given.
descriptionstring- Internal description for this resource, up to 255 characters.
emailstring- Email address of the recipient, up to 100 characters.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
namestring- Full name of the recipient. Required if `company` is not given.
phonestring- Phone number of the recipient, up to 40 characters.
lob_create_bank_accountRegister a US bank account for printing checks.WriteCreate Bank Account
Register a US bank account for printing checks. The account must be verified before use. Returns the bank account with `id` (starts with `bank_`), masked account number, `signatory` and `verified` status. Use create_bank_account once per account, then verify_bank_account with the two micro-deposit amounts. Handles sensitive banking data.
Inputs
account_numberstringrequired- Bank account number.
account_typestringrequired- Type of account holder: `company` or `individual`.one of
companyindividual routing_numberstringrequired- Valid 9-digit US routing number.
signatorystringrequired- Name of the signatory printed on checks.
check_templatestring- Check template: `common` (default) or `jpm` for JP Morgan Chase Positive Pay.one of
commonjpm citystring- City of the home bank. Required for the `jpm` template only.
descriptionstring- Internal description for this resource, up to 255 characters.
fractional_routing_numberstring- Fractional routing number of the home bank. Required for the `jpm` template only.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
statestring- State of the home bank. Required for the `jpm` template only.
zipcodestring- ZIP code of the home bank. Required for the `jpm` template only.
lob_create_billing_groupCreate a billing group to tag mailpieces and usage for billing.WriteCreate Billing Group
Create a billing group to tag mailpieces and usage for billing. Returns the billing group with `id` (starts with `bg_`), `name` and `description`. Use create_billing_group to organize spend, then pass its ID as billing_group_id when creating mailpieces.
Inputs
namestringrequired- Name of the billing group.
descriptionstring- Description of the billing group.
lob_create_campaignCreate a draft campaign that groups creatives and an audience for a bulk mailing.WriteCreate Campaign
Create a draft campaign that groups creatives and an audience for a bulk mailing. Returns the campaign with `id` (starts with `cmp_`), `name`, `schedule_type`, `is_draft` and its creatives. Use create_campaign to start a bulk mailing, then attach creatives with create_creative and send it with send_campaign.
Inputs
namestringrequired- Name of the campaign.
schedule_typestringrequired- How the campaign is scheduled. Only `immediate` is available today.one of
immediate use_typestringrequired- Purpose of the mailpieces: `marketing` or `operational`.one of
marketingoperational auto_cancel_if_ncoaboolean- Automatically cancel a mailpiece instead of sending it if its address changed via NCOA.
billing_group_idstring- ID of a billing group (starts with `bg_`) to tag usage with. Requires special activation on your Lob account.
cancel_window_campaign_minutesinteger- Minutes after sending during which the campaign can still be canceled.
descriptionstring- Internal description for this resource, up to 255 characters.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
print_speedstring- Production speed. Only `core` (2 production business days) is available.one of
core send_datestring- Date to send the campaign (ISO 8601), used with scheduled-send scheduling.
target_delivery_datestring- Target delivery date for the mailpieces (ISO 8601 date), used with target-delivery scheduling.
lob_create_checkCreate and mail a physical check drawn on a verified bank account.WriteCreate Check
Create and mail a physical check drawn on a verified bank account. In live mode this mails a real check and is billed. Returns the check with `id` (starts with `chk_`), `to`, `from`, `amount`, `bank_account`, `check_number`, `expected_delivery_date`, `thumbnails` and `url`. Use create_check to pay someone by mail. The bank account must first be created with create_bank_account and verified with verify_bank_account. Provide either `message` (printed under the check) or `check_bottom` artwork.
Inputs
amountnumberrequired- Payment amount in US dollars, up to 999999.99, rounded to two decimals.
bank_accountstringrequired- ID of a verified bank account (starts with `bank_`) the check is drawn on.
fromstringrequired- Sender address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
tostringrequired- Payee address. Checks can only be sent within the US. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
use_typestringrequired- Declares the purpose of the mailpiece: `marketing` or `operational`. Required by Lob unless your account has a default use type set.one of
marketingoperational attachmentstring- Document to include with the check: HTML, a template ID or a URL to a PDF.
billing_group_idstring- ID of a billing group (starts with `bg_`) to tag usage with. Requires special activation on your Lob account.
check_bottomstring- Artwork for the bottom of the check page: HTML, a template ID or a URL to a PDF, PNG or JPG. Required if `message` is not given.
check_numberinteger- Check number, up to 500000000. If omitted, numbering starts at 10000 and increments.
descriptionstring- Internal description for this resource, up to 255 characters.
idempotency_keystring- Unique string (up to 256 characters) that makes the create call safe to retry; repeating it returns the original resource instead of mailing twice.
logostring- URL of an image printed in grayscale in the upper-left corner of the check.
mail_typestring- Checks are always sent `usps_first_class`; leave empty.one of
usps_first_class memostring- Text for the memo line of the check.
merge_variablesobject- Values for the merge variables in your HTML template or QR code redirect URL, as a JSON object. Example: {"first_name": "Ada"}.
messagestring- Text printed at the bottom of the check page, up to 400 characters. Required if `check_bottom` is not given.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
print_speedstring- Production speed. Only `core` (2 production business days) is available.one of
core send_datestring- ISO 8601 date or datetime, after now and up to 180 days ahead, at which to send the piece to production. Omit to send immediately.
service_request_numberstring- Service request number of an approved USPS promotion to apply to this mailpiece.
lob_create_creativeCreate the artwork for a campaign: a postcard, letter or self mailer design.WriteCreate Creative
Create the artwork for a campaign: a postcard, letter or self mailer design. Returns the creative with `id` (starts with `crv_`), `resource_type`, `details` and preview URLs. Use create_creative to attach artwork to a draft campaign. Use update_creative to change its description or sender. Give `front` and `back` for postcards, `file` for letters, or `inside` and `outside` for self mailers.
Inputs
campaign_idstringrequired- ID of the campaign this creative belongs to (starts with `cmp_`).
detailsobjectrequired- Settings for the mailpiece type. For a postcard, for example, `size`; for a letter `color` and `double_sided`; for a self mailer `size`. Example: {"size": "4x6"}.
resource_typestringrequired- Type of mailpiece: `postcard`, `letter` or `self_mailer`.one of
postcardletterself_mailer backstring- Postcard back artwork (HTML, template ID or URL). Postcards only.
descriptionstring- Internal description for this resource, up to 255 characters.
filestring- Letter artwork (HTML, template ID or PDF URL). Letters only.
fromstring- Sender address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
frontstring- Postcard front artwork (HTML, template ID or URL). Postcards only.
insidestring- Self mailer inside artwork (HTML, template ID or URL). Self mailers only.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
outsidestring- Self mailer outside artwork (HTML, template ID or URL). Self mailers only.
lob_create_domainRegister a custom domain for short links.WriteCreate Domain
Register a custom domain for short links. Returns the domain with `id`, `domain`, `status` and `error_redirect_link`. Use create_domain to add a branded short-link domain, then configure its DNS.
Inputs
domainstringrequired- The domain or hostname to register.
error_redirect_linkstring- URL to redirect visitors to when a short link is broken or inactive.
lob_create_letterCreate and mail a letter.WriteCreate Letter
Create and mail a letter. In live mode this prints and mails a real piece and is billed. Returns the letter with `id` (starts with `ltr_`), `to`, `from`, `color`, `expected_delivery_date`, `tracking_number` where applicable, `thumbnails` and `url`. Use create_letter to send a letter. Use create_postcard for postcards and create_check for checks. Test API keys render a proof without mailing anything.
Inputs
colorbooleanrequired- `true` to print in color, `false` for black and white.
filestringrequired- Artwork for the letter pages (PDF pages must be 8.5x11 inches): an HTML string (up to 10,000 characters), a template ID (starts with `tmpl_`), or a publicly reachable URL to a PDF, PNG or JPG file of the correct dimensions.
fromstringrequired- Sender address (a US address unless a custom envelope is used). Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
tostringrequired- Recipient address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
use_typestringrequired- Declares the purpose of the mailpiece: `marketing` or `operational`. Required by Lob unless your account has a default use type set.one of
marketingoperational address_placementstring- Where the address block sits for the window envelope: `top_first_page` (default), `insert_blank_page`, `bottom_first_page_center` or `bottom_first_page`.one of
top_first_pageinsert_blank_pagebottom_first_page_centerbottom_first_page billing_group_idstring- ID of a billing group (starts with `bg_`) to tag usage with. Requires special activation on your Lob account.
custom_envelopestring- ID of a custom envelope with available inventory. The letter is not sent if there is none.
descriptionstring- Internal description for this resource, up to 255 characters.
double_sidedboolean- `true` (default) prints on both sides of each sheet, `false` on one side.
extra_servicestring- Add `certified`, `certified_return_receipt` or `registered` delivery. Not allowed with `usps_standard` mail.one of
certifiedcertified_return_receiptregistered fscboolean- Beta: print the mailpiece on Forest Stewardship Council certified paper. Contact Lob to enable.
idempotency_keystring- Unique string (up to 256 characters) that makes the create call safe to retry; repeating it returns the original resource instead of mailing twice.
mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard merge_variablesobject- Values for the merge variables in your HTML template or QR code redirect URL, as a JSON object. Example: {"first_name": "Ada"}.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
perforated_pageinteger- Page number to perforate for the return envelope, at least 1. Required when `return_envelope` is true.
print_speedstring- Production speed. Only `core` (2 production business days) is available.one of
core qr_codeobject- Places a QR code on the artwork. Give a position (for example `top_left`, `bottom_right`) or explicit offsets, a redirect_url the code points to, and optionally width and pages. Example: {"position": "bottom_right", "redirect_url": "https://example.com/offer", "width": "1.5"}.
return_envelopeboolean- `true` includes a return envelope (then set `perforated_page`), or give a custom return envelope ID if your account has them.
send_datestring- ISO 8601 date or datetime, after now and up to 180 days ahead, at which to send the piece to production. Omit to send immediately.
service_request_numberstring- Service request number of an approved USPS promotion to apply to this mailpiece.
sizestring- Letter size: `us_letter` (default) or `us_legal`.one of
us_letterus_legal
lob_create_linkCreate a shortened, trackable link that redirects to a target URL.WriteCreate Short Link
Create a shortened, trackable link that redirects to a target URL. Returns the link with `id`, `short_link`, `redirect_link`, `domain_id` and `title`. Use create_link to build a short URL for a mailpiece. Use list_domains to see which custom domains are available.
Inputs
redirect_linkstringrequired- The original target URL the short link redirects to.
domainstring- Registered domain for the short URL. Defaults to `lob.st`.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
slugstring- Path of the short URL. A unique path is generated if empty.
titlestring- Title of the link.
lob_create_postcardCreate and mail a postcard.WriteCreate Postcard
Create and mail a postcard. In live mode this prints and mails a real piece and is billed. Returns the postcard with `id` (starts with `psc_`), `to`, `from`, `size`, `expected_delivery_date`, `thumbnails`, `url` and `carrier`. Use create_postcard to send a postcard. Use create_letter for letters and create_self_mailer for folded mailers. Test API keys render a proof without mailing anything.
Inputs
backstringrequired- Artwork for the back of the postcard: an HTML string (up to 10,000 characters), a template ID (starts with `tmpl_`), or a publicly reachable URL to a PDF, PNG or JPG file of the correct dimensions.
frontstringrequired- Artwork for the front of the postcard: an HTML string (up to 10,000 characters), a template ID (starts with `tmpl_`), or a publicly reachable URL to a PDF, PNG or JPG file of the correct dimensions.
tostringrequired- Recipient address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
use_typestringrequired- Declares the purpose of the mailpiece: `marketing` or `operational`. Required by Lob unless your account has a default use type set.one of
marketingoperational billing_group_idstring- ID of a billing group (starts with `bg_`) to tag usage with. Requires special activation on your Lob account.
descriptionstring- Internal description for this resource, up to 255 characters.
fromstring- Sender address, required if the recipient is international. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
fscboolean- Beta: print the mailpiece on Forest Stewardship Council certified paper. Contact Lob to enable.
idempotency_keystring- Unique string (up to 256 characters) that makes the create call safe to retry; repeating it returns the original resource instead of mailing twice.
mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard merge_variablesobject- Values for the merge variables in your HTML template or QR code redirect URL, as a JSON object. Example: {"first_name": "Ada"}.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
print_speedstring- Production speed. Only `core` (2 production business days) is available.one of
core qr_codeobject- Places a QR code on the artwork. Give a position (for example `top_left`, `bottom_right`) or explicit offsets, a redirect_url the code points to, and optionally width and pages. Example: {"position": "bottom_right", "redirect_url": "https://example.com/offer", "width": "1.5"}.
send_datestring- ISO 8601 date or datetime, after now and up to 180 days ahead, at which to send the piece to production. Omit to send immediately.
service_request_numberstring- Service request number of an approved USPS promotion to apply to this mailpiece.
sizestring- Postcard size: `4x6` (default), `6x9` or `6x11`. Only 4x6 can go to international addresses.one of
4x66x96x11
lob_create_self_mailerCreate and mail a folded self mailer.WriteCreate Self Mailer
Create and mail a folded self mailer. In live mode this prints and mails a real piece and is billed. Returns the self mailer with `id` (starts with `sfm_`), `to`, `from`, `size`, `expected_delivery_date`, `thumbnails` and `url`. Use create_self_mailer for bifold or trifold mailers. Use create_postcard for single-card pieces. Test API keys render a proof without mailing anything.
Inputs
insidestringrequired- Artwork for the inside of the self mailer: an HTML string (up to 10,000 characters), a template ID (starts with `tmpl_`), or a publicly reachable URL to a PDF, PNG or JPG file of the correct dimensions.
outsidestringrequired- Artwork for the outside of the self mailer: an HTML string (up to 10,000 characters), a template ID (starts with `tmpl_`), or a publicly reachable URL to a PDF, PNG or JPG file of the correct dimensions.
tostringrequired- Recipient address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
use_typestringrequired- Declares the purpose of the mailpiece: `marketing` or `operational`. Required by Lob unless your account has a default use type set.one of
marketingoperational billing_group_idstring- ID of a billing group (starts with `bg_`) to tag usage with. Requires special activation on your Lob account.
descriptionstring- Internal description for this resource, up to 255 characters.
fromstring- Sender address, required if the recipient is international. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
fscboolean- Beta: print the mailpiece on Forest Stewardship Council certified paper. Contact Lob to enable.
idempotency_keystring- Unique string (up to 256 characters) that makes the create call safe to retry; repeating it returns the original resource instead of mailing twice.
mail_typestring- Postage type: `usps_first_class` (default) or `usps_standard` (cheaper, slower, marketing only).one of
usps_first_classusps_standard merge_variablesobject- Values for the merge variables in your HTML template or QR code redirect URL, as a JSON object. Example: {"first_name": "Ada"}.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
print_speedstring- Production speed. Only `core` (2 production business days) is available.one of
core qr_codeobject- Places a QR code on the artwork. Give a position (for example `top_left`, `bottom_right`) or explicit offsets, a redirect_url the code points to, and optionally width and pages. Example: {"position": "bottom_right", "redirect_url": "https://example.com/offer", "width": "1.5"}.
send_datestring- ISO 8601 date or datetime, after now and up to 180 days ahead, at which to send the piece to production. Omit to send immediately.
service_request_numberstring- Service request number of an approved USPS promotion to apply to this mailpiece.
sizestring- Self mailer size: `6x18_bifold` (default), `11x9_bifold`, `12x9_bifold` or `17.75x9_trifold` (beta).one of
6x18_bifold11x9_bifold12x9_bifold17.75x9_trifold
lob_create_templateCreate a reusable HTML template that can be used as artwork for mailpieces.WriteCreate Template
Create a reusable HTML template that can be used as artwork for mailpieces. Returns the template with `id` (starts with `tmpl_`), `published_version` and a `versions` array holding the first version. Use create_template to start a new template. Use create_template_version to add a revision to an existing one.
Inputs
htmlstringrequired- HTML for the first published version, under 100,000 characters. Use {{variable}} placeholders for merge variables.
descriptionstring- Internal description for this resource, up to 255 characters.
enginestring- Template engine used to merge variables: `legacy` (default, Lob's original engine) or `handlebars`.one of
legacyhandlebars metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
required_varsarray- Variables the template needs when used. Only for `handlebars` templates. Example: ["first_name", "offer_code"].
lob_create_template_versionAdd a new version with new HTML to an existing template.WriteCreate Template Version
Add a new version with new HTML to an existing template. Returns the new version with `id` (starts with `vrsn_`), `html`, `engine` and `required_vars`. Use create_template_version to revise a template's HTML. The new version is not published until update_template sets it as the published version.
Inputs
htmlstringrequired- HTML for the new version, under 100,000 characters.
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
descriptionstring- Internal description for this resource, up to 255 characters.
enginestring- Template engine used to merge variables: `legacy` (default, Lob's original engine) or `handlebars`.one of
legacyhandlebars required_varsarray- Variables the template needs when used. Only for `handlebars` templates. Example: ["first_name", "offer_code"].
lob_send_campaignSend a campaign, which prints and mails its pieces to the audience.WriteSend Campaign
Send a campaign, which prints and mails its pieces to the audience. In live mode this is billed and cannot be undone after the cancel window. Returns the campaign with its updated scheduling state. Use send_campaign after creatives and audience are ready. Use get_campaign first to verify. The campaign needs at least one creative and an uploaded audience.
Inputs
campaign_idstringrequired- ID of the campaign, prefixed with `cmp_`.
lob_update_billing_groupUpdate a billing group's name or description.WriteUpdate Billing Group
Update a billing group's name or description. Returns the updated billing group. Use update_billing_group to rename a group without changing its ID.
Inputs
billing_group_idstringrequired- ID of the billing group, prefixed with `bg_`.
descriptionstring- Description of the billing group.
namestring- Name of the billing group.
lob_update_campaignUpdate a campaign's name, scheduling or settings.WriteUpdate Campaign
Update a campaign's name, scheduling or settings. Returns the updated campaign. Use update_campaign to change a draft campaign. Use send_campaign to launch it.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign, prefixed with `cmp_`.
auto_cancel_if_ncoaboolean- Automatically cancel a mailpiece instead of sending it if its address changed via NCOA.
cancel_window_campaign_minutesinteger- Minutes after sending during which the campaign can still be canceled.
descriptionstring- Internal description for this resource, up to 255 characters.
is_draftboolean- Whether the campaign is still a draft. Leave empty or `false`.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
namestring- New name of the campaign.
schedule_typestring- How the campaign is scheduled. Only `immediate` is available today.one of
immediate send_datestring- Date to send the campaign (ISO 8601), used with scheduled-send scheduling.
target_delivery_datestring- Target delivery date for the mailpieces (ISO 8601 date), used with target-delivery scheduling.
use_typestring- Purpose of the mailpieces: `marketing` or `operational`.one of
marketingoperational
lob_update_creativeUpdate a creative's sender address, description or metadata.WriteUpdate Creative
Update a creative's sender address, description or metadata. Returns the updated creative. Use update_creative for these fields; artwork changes need a new creative from create_creative.
- Idempotent
Inputs
creative_idstringrequired- ID of the creative, prefixed with `crv_`.
descriptionstring- Internal description for this resource, up to 255 characters.
fromstring- Sender address. Either the ID of a saved address (starts with `adr_`) or an inline address object. An inline object needs name, address_line1, address_city, address_state and address_zip for US addresses, or address_line1 and address_country for international ones; address_line2, company, phone and email are optional. Example: {"name": "Ada Lovelace", "address_line1": "210 King St", "address_city": "San Francisco", "address_state": "CA", "address_zip": "94107"}.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
lob_update_linkChange the destination, title or metadata of a short link.WriteUpdate Short Link
Change the destination, title or metadata of a short link. Returns the updated link. Use update_link to repoint a link without changing its short URL.
- Idempotent
Inputs
link_idstringrequired- ID of the short link, prefixed with `link_`.
redirect_linkstringrequired- The new target URL. Required by Lob on every update.
metadataobject- Custom key-value pairs for tagging this resource (up to 20 pairs; keys up to 40 characters, values up to 500 characters; string values only). Example: {"customer_id": "cus_42"}.
titlestring- New title of the link.
lob_update_templateUpdate a template's description or switch which version is published.WriteUpdate Template
Update a template's description or switch which version is published. Returns the updated template with `id`, `description` and `published_version`. Use update_template to rename or publish a different version. Use create_template_version to change the HTML.
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
descriptionstring- Internal description for this resource, up to 255 characters.
published_versionstring- ID of the version (starts with `vrsn_`) to publish as the live version of this template.
lob_update_template_versionUpdate the description, engine or required variables of a template version.WriteUpdate Template Version
Update the description, engine or required variables of a template version. Returns the updated version with `id`, `description`, `engine` and `required_vars`. Use update_template_version for metadata changes. HTML cannot be edited; create a new version with create_template_version.
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
version_idstringrequired- ID of the template version, prefixed with `vrsn_`.
descriptionstring- Internal description for this resource, up to 255 characters.
enginestring- Template engine used to merge variables: `legacy` (default, Lob's original engine) or `handlebars`.one of
legacyhandlebars required_varsarray- Variables the template needs when used. Only for `handlebars` templates. Example: ["first_name", "offer_code"].
lob_verify_bank_accountVerify a bank account with the two micro-deposit amounts, or a descriptor code, sent by Lob.WriteVerify Bank Account
Verify a bank account with the two micro-deposit amounts, or a descriptor code, sent by Lob. Returns the bank account with `verified: true` when the check succeeds. Use verify_bank_account after create_bank_account and the deposits arrive. Provide either `amounts` (two amounts in cents) or `descriptor_code`.
Inputs
bank_account_idstringrequired- ID of the bank account, prefixed with `bank_`.
amountsarray- The two micro-deposit amounts in cents, as a two-element list of integers. Example: [11, 35]. Use this or `descriptor_code`.
descriptor_codestring- Descriptor code from the bank statement deposit, as an alternative to `amounts`.
lob_cancel_checkCancel a check before it goes to production.DestructiveCancel Check
Cancel a check before it goes to production. Returns an object with the deleted record's `id` and `deleted: true`. Use cancel_check to stop a scheduled or recently created check. Cancellation fails once the check has been produced.
- Idempotent
Inputs
check_idstringrequired- ID of the check, prefixed with `chk_`.
lob_cancel_letterCancel a letter before it goes to production.DestructiveCancel Letter
Cancel a letter before it goes to production. Returns an object with the deleted record's `id` and `deleted: true`. Use cancel_letter to stop a scheduled or recently created letter. Cancellation fails once the piece has been produced.
- Idempotent
Inputs
letter_idstringrequired- ID of the letter, prefixed with `ltr_`.
lob_cancel_postcardCancel a postcard before it goes to production.DestructiveCancel Postcard
Cancel a postcard before it goes to production. Returns an object with the deleted record's `id` and `deleted: true`. Use cancel_postcard to stop a scheduled or recently created postcard. Cancellation fails once the piece has been produced.
- Idempotent
Inputs
postcard_idstringrequired- ID of the postcard, prefixed with `psc_`.
lob_cancel_self_mailerCancel a self mailer before it goes to production.DestructiveCancel Self Mailer
Cancel a self mailer before it goes to production. Returns an object with the deleted record's `id` and `deleted: true`. Use cancel_self_mailer to stop a scheduled or recently created self mailer. Cancellation fails once the piece has been produced.
- Idempotent
Inputs
self_mailer_idstringrequired- ID of the self mailer, prefixed with `sfm_`.
lob_delete_addressPermanently delete a saved address from the address book.DestructiveDelete Address
Permanently delete a saved address from the address book. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_address to remove an address you no longer need. Mailpieces already created keep their copy of the address.
- Idempotent
Inputs
address_idstringrequired- ID of the address, prefixed with `adr_`.
lob_delete_bank_accountPermanently delete a bank account.DestructiveDelete Bank Account
Permanently delete a bank account. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_bank_account to remove an account that should no longer be used for checks.
- Idempotent
Inputs
bank_account_idstringrequired- ID of the bank account, prefixed with `bank_`.
lob_delete_campaignDelete a campaign.DestructiveDelete Campaign
Delete a campaign. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_campaign to remove a campaign that has not been sent.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign, prefixed with `cmp_`.
lob_delete_domainDelete a registered short-link domain.DestructiveDelete Domain
Delete a registered short-link domain. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_domain to remove a domain you no longer use.
- Idempotent
Inputs
domain_idstringrequired- ID of the domain, prefixed with `dom_`.
lob_delete_linkDelete a short link.DestructiveDelete Short Link
Delete a short link. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_link to deactivate a short link that is no longer needed.
- Idempotent
Inputs
link_idstringrequired- ID of the short link, prefixed with `link_`.
lob_delete_templatePermanently delete a template and all of its versions.DestructiveDelete Template
Permanently delete a template and all of its versions. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_template only when the template is no longer used. Use delete_template_version to remove a single version.
- Idempotent
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
lob_delete_template_versionPermanently delete one version of a template.DestructiveDelete Template Version
Permanently delete one version of a template. Returns an object with the deleted record's `id` and `deleted: true`. Use delete_template_version to remove a single revision. The published version cannot be deleted; use delete_template to remove everything.
- Idempotent
Inputs
template_idstringrequired- ID of the template, prefixed with `tmpl_`.
version_idstringrequired- ID of the template version, prefixed with `vrsn_`.
No tools match.
