Lob
Explore the interactive ERD
Table & Field Reference
template_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
template_id | String | PKFK |
value | Unknown |
template
| Column | Type | Keys |
|---|---|---|
id | String | PK |
published_version_id | String | FK |
date_created | Instant | |
date_modified | Instant | |
description | String | |
html | String |
template_version_merge_variable
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
template_version_id | String | PKFK |
value | Unknown |
template_version
| Column | Type | Keys |
|---|---|---|
id | String | PK |
template_id | String | FK |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
engine | String | |
html | String | |
suggest_json_editor | Boolean |
billing_group
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
date_created | Unknown | |
date_modified | Unknown | |
description | Unknown | |
metadata | Json | |
name | Unknown | |
object | Unknown |
postcard_thumbnail
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
postcard_id | String | PKFK |
large | String | |
medium | String | |
small | String |
postcard_tracking_event
| Column | Type | Keys |
|---|---|---|
id | String | PK |
postcard_id | String | PKFK |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
details_action_required | Boolean | |
details_description | String | |
details_event | String | |
details_notes | String | |
location | String | |
name | String | |
time | Instant | |
type | String |
postcard_to_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
postcard_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
email | Unknown | |
meta_data | Json | |
name | String | |
object | Unknown | |
phone | String | |
recipient_moved | Boolean |
postcard_from_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
postcard_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
email | Unknown | |
meta_data | Json | |
name | String | |
object | Unknown | |
phone | String | |
recipient_moved | Boolean |
postcard_failure_reason_error
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
postcard_id | String | PKFK |
error_type | Unknown | |
host | Unknown | |
path | Unknown | |
protocol | Unknown | |
remediation | Unknown | |
status_code | Unknown | |
url | Unknown |
postcard_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
postcard_id | String | PKFK |
value | Unknown |
postcard_merge_variable
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
postcard_id | String | PKFK |
value | Unknown |
postcard
| Column | Type | Keys |
|---|---|---|
id | String | PK |
back_template_id | String | FK |
back_template_version_id | String | FK |
campaign_id | String | FK |
front_template_id | String | FK |
front_template_version_id | String | FK |
carrier | String | |
completed_at | Unknown | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
expected_delivery_date | Unknown | |
failure_reason | String | |
failure_reason_remediation | String | |
fsc | Unknown | |
is_creative_proof | Unknown | |
is_dashboard | Unknown | |
lob_credits_funding_status | Unknown | |
mail_type | String | |
qr_code | Unknown | |
raw_url | Unknown | |
send_date | Instant | |
size | String | |
status | Unknown | |
to_be_expunged_date | Unknown | |
url | Unknown | |
use_type | Unknown | |
usps_campaign_id | Unknown |
qr_code_scan
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
qr_code_id | Unknown | PKFK |
ip_location | Unknown | |
scan_date | Unknown |
qr_code
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
date_created | Unknown | |
number_of_scan | Unknown |
bank_account_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
bank_account_id | String | PKFK |
value | Unknown |
bank_account
| Column | Type | Keys |
|---|---|---|
id | String | PK |
account_number | Long | |
account_type | String | |
bank_name | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
routing_number | Long | |
signatory | String | |
signature_url | String | |
verified | Boolean |
address_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
address_id | String | PKFK |
value | Unknown |
address
| Column | Type | Keys |
|---|---|---|
id | String | PK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
self_mailer_thumbnail
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
self_mailer_id | String | PKFK |
large | String | |
medium | String | |
small | String |
self_mailer_tracking_event
| Column | Type | Keys |
|---|---|---|
id | String | PK |
self_mailer_id | String | PKFK |
date_created | Unknown | |
date_modified | Unknown | |
deleted | Boolean | |
details_action_required | String | |
details_description | String | |
details_event | String | |
details_notes | String | |
location | String | |
name | String | |
time | Unknown | |
type | String |
self_mailer_to_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
self_mailer_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
self_mailer_from_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
self_mailer_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
self_mailer_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
self_mailer_id | String | PKFK |
value | Unknown |
self_mailer_merge_variable
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
self_mailer_id | String | PKFK |
value | Unknown |
self_mailer
| Column | Type | Keys |
|---|---|---|
id | String | PK |
inside_template_id | String | FK |
inside_template_version_id | String | FK |
outside_template_id | String | FK |
outside_template_version_id | String | FK |
carrier | Unknown | |
date_created | Instant | |
date_modified | Unknown | |
deleted | Boolean | |
description | String | |
expected_delivery_date | Unknown | |
mail_type | String | |
send_date | Unknown | |
size | String |
check_thumbnail
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
checks_id | String | PKFK |
large | String | |
medium | String | |
small | String |
check_tracking_event
| Column | Type | Keys |
|---|---|---|
id | String | PK |
checks_id | String | PKFK |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
details_action_required | Boolean | |
details_description | String | |
details_event | String | |
details_notes | String | |
location | String | |
name | String | |
time | Instant | |
type | String |
check_to_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
checks_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
check_from_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
checks_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
check_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
checks_id | String | PKFK |
value | Unknown |
check_merge_variable
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
checks_id | String | PKFK |
value | Unknown |
checks
| Column | Type | Keys |
|---|---|---|
id | String | PK |
attachment_template_id | String | FK |
attachment_template_version_id | String | FK |
bank_account_id | Unknown | FK |
check_bottom_template_id | String | FK |
check_bottom_template_version_id | String | FK |
amount | Double | |
carrier | String | |
check_number | Int | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
expected_delivery_date | Unknown | |
mail_type | String | |
memo | String | |
message | String | |
send_date | Unknown |
letter_thumbnail
| Column | Type | Keys |
|---|---|---|
index | Unknown | PK |
letter_id | String | PKFK |
large | String | |
medium | String | |
small | String |
letter_tracking_event
| Column | Type | Keys |
|---|---|---|
id | String | PK |
letter_id | String | PKFK |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
details_action_required | Boolean | |
details_description | String | |
details_event | String | |
details_notes | String | |
location | String | |
name | String | |
time | Instant | |
type | String |
letter_to_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
letter_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
letter_from_address
| Column | Type | Keys |
|---|---|---|
address_id | String | PKFK |
letter_id | String | PKFK |
address_city | String | |
address_country | String | |
address_line_1 | String | |
address_line_2 | String | |
address_state | String | |
address_zip | String | |
company | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
name | String | |
phone | String | |
recipient_moved | Boolean |
letter_metadata
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
letter_id | String | PKFK |
value | Unknown |
letter_merge_variable
| Column | Type | Keys |
|---|---|---|
name | Unknown | PK |
letter_id | String | PKFK |
value | Unknown |
letter
| Column | Type | Keys |
|---|---|---|
id | String | PK |
campaign_id | String | FK |
template_id | String | FK |
template_version_id | String | FK |
address_placement | String | |
carrier | String | |
color | String | |
custom_envelope_id | String | |
date_created | Instant | |
date_modified | Instant | |
deleted | Boolean | |
description | String | |
double_sided | Boolean | |
expected_delivery_date | Unknown | |
extra_service | String | |
mail_type | String | |
perforated_page | Int | |
return_envelope | String | |
send_date | Instant | |
tracking_number | String | |
use_type | String |
campaign_creative_template_preview
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
campaign_creative_campaign_id | Unknown | PKFK |
campaign_creative_id | Unknown | PKFK |
template_id | Unknown | FK |
campaign_creative
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
campaign_id | Unknown | PKFK |
from_address | Unknown | FK |
date_created | Unknown | |
date_modified | Unknown | |
deleted | Unknown | |
description | Unknown | |
details_back_original_url | Unknown | |
details_back_template_id | Unknown | |
details_front_original_url | Unknown | |
details_front_template_id | Unknown | |
details_fsc | Unknown | |
details_mail_type | Unknown | |
details_setting | Unknown | |
details_size | Unknown | |
metadata | Json | |
resource_type | Unknown | |
template_preview_url_back | Unknown | |
template_preview_url_front | Unknown | |
use_personalized_return_address | Unknown |
campaign_upload
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
campaign_id | Unknown | PKFK |
account_id | Unknown | |
api_version | Unknown | |
date_created | Unknown | |
date_modified | Unknown | |
deleted | Unknown | |
failed_mail_piece | Unknown | |
failures_url | Unknown | |
merge_variable_column_mapping | Unknown | |
metadata | Json | |
mode | Unknown | |
optinal_address_country | Unknown | |
optinal_address_line_2 | Unknown | |
optinal_company | Unknown | |
original_file_name | Unknown | |
required_address_city | Unknown | |
required_address_line_1 | Unknown | |
required_address_state | Unknown | |
required_address_zip | Unknown | |
required_name | Unknown | |
return_address_city | Unknown | |
return_address_company | Unknown | |
return_address_country | Unknown | |
return_address_line_1 | Unknown | |
return_address_line_2 | Unknown | |
return_address_name | Unknown | |
return_address_state | Unknown | |
return_address_zip | Unknown | |
state | Unknown | |
total_mail_piece | Unknown | |
validated_mail_piece | Unknown |
campaign
| Column | Type | Keys |
|---|---|---|
id | Unknown | PK |
audience | Json | |
auto_cancel_if_ncoa | Unknown | |
billing_group_id | Unknown | |
cancel_window_campaign_minute | Unknown | |
date_created | Unknown | |
date_modified | Unknown | |
date_ordered | Unknown | |
deleted | Unknown | |
description | Unknown | |
is_active | Unknown | |
is_draft | Unknown | |
mail_destination | Unknown | |
merge_variable_strictness | Unknown | |
metadata | Json | |
name | Unknown | |
print_speed | Unknown | |
rules | Unknown | |
schedule_type | Unknown | |
send_date | Unknown | |
send_type | Unknown | |
service_request_number | Unknown | |
status | Unknown | |
target_delivery_date | Unknown | |
use_type | Unknown |