Creates a new letter object
POST {{baseUrl}}/letters
Creates a new letter given information
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
idempotency_key | null | (optional) |
Request Body
[{"name"=>"description", "value"=>"foobar", "datatype"=>"string"}, {"name"=>"to", "value"=>"adr_58088d858a815c66", "datatype"=>"string"}, {"name"=>"from", "value"=>"adr_58088d858a815c66", "datatype"=>"string"}, {"name"=>"billing_group_id", "value"=>"", "datatype"=>"null"}, {"name"=>"send_date", "value"=>"2021-07-01", "datatype"=>"string"}, {"name"=>"color", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"file", "value"=>"<html><body><h1>Hello World</h1></body></html>", "datatype"=>"string"}, {"name"=>"double_sided", "value"=>"false", "datatype"=>"boolean"}, {"name"=>"address_placement", "value"=>"top_first_page", "datatype"=>"string"}, {"name"=>"mail_type", "value"=>"usps_first_class", "datatype"=>"string"}, {"name"=>"extra_service", "value"=>"certified", "datatype"=>"string"}, {"name"=>"return_envelope", "value"=>"false", "datatype"=>"boolean"}, {"name"=>"perforated_page", "value"=>"3", "datatype"=>"number"}, {"name"=>"custom_envelope", "value"=>"env_123", "datatype"=>"string"}, {"name"=>"merge_variables", "value"=>"{\"name\": \"Harry\"}", "datatype"=>"string"}, {"name"=>"metadata", "value"=>"{\"customer_id\": \"987654\"}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Idempotency-Key | number | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our implementation guide. | |
Content-Type | string |
RESPONSES
status: OK
{"id":"ltr_4868c3b754655f90","description":"Demo Letter","metadata":{},"to":{"id":"adr_d3489cd64c791ab5","description":null,"name":"HARRY ZHANG","company":null,"phone":null,"email":null,"address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2017-09-05T15:54:53.264Z","date_modified":"2017-09-05T15:54:53.264Z","deleted":true,"object":"address"},"from":{"id":"adr_b8fb5acf3a2b55db","description":null,"name":"LEORE AVIDAR","company":null,"phone":null,"email":null,"address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2017-09-05T15:54:53.264Z","date_modified":"2017-09-05T15:54:53.264Z","deleted":true,"object":"address"},"color":true,"double_sided":true,"address_placement":"top_first_page","return_envelope":false,"perforated_page":null,"custom_envelope":null,"extra_service":null,"mail_type":"usps_first_class","url":"https://lob-assets.com/letters/ltr_4868c3b754655f90.pdf?expires=1540372221\u0026signature=8r94fse8uam7wGWmW5baxXulU88X2CA","carrier":"USPS","tracking_number":null,"tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/letters/ltr_4868c3b754655f90_thumb_small_1.png?expires=1540372221\u0026signature=a5fRBJ22ZA78Vgpg34M9UfmHWTS3eha","medium":"https://lob-assets.com/letters/ltr_4868c3b754655f90_thumb_medium_1.png?expires=1540372221\u0026signature=bAzL8sv935PY09FWSkpDpWKkyvGSWYF","large":"https://lob-assets.com/letters/ltr_4868c3b754655f90_thumb_large_1.png?expires=1540372221\u0026signature=gsKvxXgrm4v4iZD3bOibK7jApNkEMdW"}],"merge_variables":{"name":"Harry"},"expected_delivery_date":"2017-09-12","date_created":"2017-09-05T15:54:53.346Z","date_modified":"2017-09-05T15:54:53.346Z","send_date":"2017-09-05T15:54:53.346Z","object":"letter"}