# Lob

Direct Mail Automation and Address Verification APIs

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 13
- **Triggers:** 0
- **Slug:** `LOB`
- **Version:** 00000000_00

## Tools

### Create Domain

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The registered domain/hostname. |
| `error_redirect_link` | string | Yes | URL to redirect customers if a short link is broken or inactive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Link

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `slug` | string | No | The unique path for the shortened URL. If empty, a unique path will be automatically generated. |
| `title` | string | No | The title of the URL. |
| `domain` | string | No | The registered domain to be used for the short URL. Defaults to 'lob.st'. |
| `metadata` | object | No | 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 `\`. |
| `redirect_link` | string | Yes | The original target URL to be shortened. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Domain

**Slug:** `LOB_DELETE_DOMAIN`

Tool to delete a registered domain. Use only after confirming all associated links with the domain are deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | Unique identifier for a domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Link

**Slug:** `LOB_DELETE_LINK`

Tool to delete a shortened link. Use when you need to remove a previously created short link from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Unique identifier for a link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Upload

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `upl_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Domain

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_id` | string | Yes | Unique identifier for a domain. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Link

**Slug:** `LOB_GET_LINK`

Tool to retrieve a single shortened link. Use when you need to fetch details about a specific link by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Unique identifier for a link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | A reference to a list entry used for paginating to the next set of entries. Cannot be used with 'before'. |
| `limit` | integer | No | How many results to return. Maximum of 100 results per request. |
| `before` | string | No | A reference to a list entry used for paginating to the previous set of entries. Cannot be used with 'after'. |
| `status` | string ("configured" | "not_configured") | No | Status of domain configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shortened Links

**Slug:** `LOB_LIST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination. Retrieve results after this cursor. Cannot be used with 'before'. |
| `limit` | integer | No | How many results to return. Default is 10. |
| `before` | string | No | Cursor for pagination. Retrieve results before this cursor. Cannot be used with 'after'. |
| `domain_id` | string | No | Filters links by the provided domain id. |
| `campaign_id` | string | No | Filters resources created by the provided campaign id, prefixed with 'cmp_'. In the case of snap packs, booklets, and letters with size 'us_legal', however, the campaign id is prefixed with 'camp_' instead of 'cmp_'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List QR Code Analytics

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many results to return. |
| `offset` | integer | No | An integer that designates the offset at which to begin returning results. Defaults to 0. |
| `include` | array | No | Request that the response include the total count by specifying include=["total_count"]. |
| `scanned` | boolean | No | Filter list of responses to only include QR codes with at least one scan event. |
| `date_created` | object | No | 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 ≤. |
| `resource_ids` | array | No | Filter by the resource ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Uploads

**Slug:** `LOB_LIST_UPLOADS`

Tool to list uploads from Lob. Use when you need to retrieve all uploads or filter uploads by campaign ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaignId` | string | No | ID of the campaign to filter uploads by. If provided, only returns uploads associated with this campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Link

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | The title of the URL. Useful for organizing and identifying links. |
| `link_id` | string | Yes | Unique identifier for the link to update. Must be a valid link ID prefixed with 'lnk_'. |
| `metadata` | object | No | 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 '\'. Example: {'customer_id': 'NEWYORK2015'}. Nested objects are not supported. |
| `redirect_link` | string | Yes | The original target URL to redirect to when the shortened link is accessed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Identity

**Slug:** `LOB_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City name |
| `state` | string | No | State abbreviation (2 characters) |
| `zip_code` | string | No | ZIP code (5 or 9 digits) |
| `recipient` | string | Yes | Full name of the recipient to validate against the address |
| `primary_line` | string | Yes | Primary address line (street address) |
| `secondary_line` | string | No | Secondary address line (apartment, suite, etc.) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |