Skip to main content
Lob logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: LOB
  • Version: 20261101_00

Tools

Slug: LOB_CREATE_DOMAINTool to add a new custom domain for creating custom links. Use when you need to register a domain for short link customization.

Input Parameters

string
required
The registered domain/hostname.
URL to redirect customers if a short link is broken or inactive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_DELETE_DOMAINTool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.

Input Parameters

string
required
Unique identifier for a domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_DELETE_UPLOADTool to delete an existing upload by its unique identifier. Use when you need to permanently remove an upload and its associated data.

Input Parameters

string
required
Unique identifier of the upload to delete. Format: ‘upl_’ followed by alphanumeric characters (e.g., ‘upl_test’). This permanently deletes the upload and its associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_GET_DOMAINTool 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.

Input Parameters

string
required
Unique identifier for a domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_LIST_DOMAINSTool 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.

Input Parameters

string
A reference to a list entry used for paginating to the next set of entries. Cannot be used with ‘before’.
integer
How many results to return. Maximum of 100 results per request.
string
A reference to a list entry used for paginating to the previous set of entries. Cannot be used with ‘after’.
string ("configured" | "not_configured")
Status of domain configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_LIST_QR_CODE_ANALYTICSTool 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.

Input Parameters

integer
How many results to return.
integer
An integer that designates the offset at which to begin returning results. Defaults to 0.
array
Request that the response include the total count by specifying include=[“total_count”].
boolean
Filter list of responses to only include QR codes with at least one scan event.
object
Filter by date created. Accepted formats are ISO-8601 date or datetime, e.g. { “gt”: “2012-01-01”, “lt”: “2012-01-31T12:34:56Z” } where “gt” is >, “lt” is <, “gte” is ≥, and “lte” is ≤.
array
Filter by the resource ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_LIST_UPLOADSList Lob audience uploads, optionally filtering by campaign ID. Each result represents an upload and can be used to review its processing state and associated campaign.

Input Parameters

string
ID of the campaign to filter uploads by. If provided, only returns uploads associated with this campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LOB_VALIDATE_IDENTITYAssess whether a recipient name is associated with an address. Returns a score and confidence indicating the likelihood of an association.

Input Parameters

string
City name
string
State abbreviation (2 characters)
string
ZIP code (5 or 9 digits)
string
required
Full name of the recipient to validate against the address
string
required
Primary address line (street address)
string
Secondary address line (apartment, suite, etc.)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not