Direct Mail Automation and Address Verification APIs
Toolkit · lob
v1
01Create Domaintool
02Create Linktool
03Delete Domaintool
04Delete Linktool
API Key · verified
13T · 0TR
lob
Supported tools and triggers
Each tool is a typed function your agent can call. Each trigger fires an agent run when something changes upstream.
Create Domain
Tool to add a new custom domain for creating custom links. Use when you need to register a domain for short link customization.
TOOL
Create Link
Tool to create a shortened URL from a long URL using Lob's link shortening service. Use when you need to shorten a long URL either by using a custom domain or Lob's own short domain.
TOOL
Delete Domain
Tool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.
TOOL
Delete Link
Tool to delete a shortened link. Use when you need to remove a previously created short link from the system.
TOOL
Delete Upload
Tool to delete an existing upload by its unique identifier. Use when you need to permanently remove an upload and its associated data.
TOOL
Get Domain
Tool to retrieve details for a single domain from Lob. Use when you need to get configuration status, redirect links, or other metadata for a specific domain.
TOOL
Get Link
Tool to retrieve a single shortened link. Use when you need to fetch details about a specific link by its ID.
TOOL
List Domains
Tool to retrieve a list of all created domains. Use when you need to view or manage custom domains configured for URL shortening. Supports pagination and filtering by configuration status.
TOOL
List QR Code Analytics
Tool to retrieve a list of your QR codes and their analytics data. The QR codes are returned sorted by scan date, with the most recently scanned QR codes appearing first.
TOOL
List Shortened Links
Tool to retrieve a list of shortened links. The list is sorted by creation date, with the most recently created appearing first. Use when you need to view all links or filter by campaign or domain.
TOOL
List Uploads
Tool to list uploads from Lob. Use when you need to retrieve all uploads or filter uploads by campaign ID.
TOOL
Update Link
Tool to update any properties of a shortened link. Use when you need to modify the redirect URL, title, or metadata of an existing Lob shortened link. Requires the link_id and at least the redirect_link to update.
TOOL
Validate Identity
Tool to validate whether a given name is associated with an address. Use when you need to verify identity information by checking if a recipient name matches address records.