# Lob

> Verify addresses and manage direct mail, letters, postcards and mail templates.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/lob

## Actions

### Create a letter

Create a letter and send it by mail when connected with a live key.

**Inputs**

- To (`to`, text, required): To.
- From address (`from_address`, text, required): From address.
- File (`file`, text, required): File.
- Color (`color`, true/false, required): Color.
- Description (`description`, text): Description.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "description": "example",
    "id": "example",
    "url": "example"
  }
}
```

### Create an address

Add an address to your Lob address book.

**Inputs**

- Name (`name`, text): Name.
- Address line1 (`address_line1`, text, required): Address line1.
- Address city (`address_city`, text, required): Address city.
- Address state (`address_state`, text, required): Address state.
- Address zip (`address_zip`, text, required): Address zip.
- Address line2 (`address_line2`, text): Address line2.
- Company (`company`, text): Company.
- Phone (`phone`, text): Phone.
- Email (`email`, text): Email.
- Address country (`address_country`, text): Address country.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "address_city": "example",
    "address_country": "example",
    "address_line1": "example",
    "address_line2": "example",
    "address_state": "example",
    "address_zip": "example",
    "id": "example",
    "name": "example"
  }
}
```

### Delete an address

Remove the selected address from your Lob address book.

**Inputs**

- Address (`address_id`, text, required): Address id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "deleted": false,
    "id": "example"
  }
}
```

### Get a billing group

Read the selected record and its details.

**Inputs**

- Billing group (`billing_group_id`, text, required): Billing group id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "description": "example",
    "id": "example",
    "name": "example"
  }
}
```

### Get a check

Read the selected record and its details.

**Inputs**

- Check (`check_id`, text, required): Check id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "date_created": "example",
    "description": "example",
    "id": "example",
    "tracking_events": []
  }
}
```

### Get a letter

Read the selected record and its details.

**Inputs**

- Letter (`letter_id`, text, required): Letter id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "date_created": "example",
    "description": "example",
    "id": "example",
    "tracking_events": []
  }
}
```

### Get a postcard

Read the selected record and its details.

**Inputs**

- Postcard (`postcard_id`, text, required): Postcard id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "date_created": "example",
    "description": "example",
    "id": "example",
    "tracking_events": []
  }
}
```

### Get a self-mailer

Read the selected record and its details.

**Inputs**

- Self mailer (`self_mailer_id`, text, required): Self mailer id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "date_created": "example",
    "description": "example",
    "id": "example",
    "tracking_events": []
  }
}
```

### Get a template

Read the selected record and its details.

**Inputs**

- Template (`template_id`, text, required): Template id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "description": "example",
    "id": "example",
    "name": "example"
  }
}
```

### Get an address

Read the selected record and its details.

**Inputs**

- Address (`address_id`, text, required): Address id.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "address_city": "example",
    "address_country": "example",
    "address_line1": "example",
    "address_line2": "example",
    "address_state": "example",
    "address_zip": "example",
    "id": "example",
    "name": "example"
  }
}
```

### List addresses

Read one page of addresses in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List billing groups

Read one page of billing groups in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List checks

Read one page of checks in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List letters

Read one page of letters in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List postcards

Read one page of postcards in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List self-mailers

Read one page of self-mailers in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### List templates

Read one page of templates in your Lob account.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- After (`after`, text): After.
- Before (`before`, text): Before.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_url": "example",
    "previous_url": "example"
  }
}
```

### Look up a US ZIP code

Find cities and states associated with a US ZIP code.

**Inputs**

- Zip code (`zip_code`, text, required): Zip code.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "cities": [],
    "id": "example",
    "zip_code": "example"
  }
}
```

### Suggest US addresses

Find suggested mailing addresses from the start of a US street address. Uses account allowance.

**Inputs**

- Address prefix (`address_prefix`, text, required): Address prefix.
- City (`city`, text): City.
- State (`state`, text): State.
- Zip code (`zip_code`, text): Zip code.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "id": "example",
    "suggestions": []
  }
}
```

### Verify a US address

Validate and standardize a US mailing address. Uses address verification allowance.

**Inputs**

- Primary line (`primary_line`, text, required): Primary line.
- Secondary line (`secondary_line`, text): Secondary line.
- City (`city`, text): City.
- State (`state`, text): State.
- Zip code (`zip_code`, text): Zip code.

**Outputs**: Response.

- `data` (object): Data.

**Example output**

```json
{
  "data": {
    "deliverability": "example",
    "id": "example",
    "last_line": "example",
    "primary_line": "example"
  }
}
```
