Creates a new self_mailer object
POST {{baseUrl}}/self_mailers
Creates a new self_mailer given information
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
idempotency_key | null | (optional) |
Request Body
[{"name"=>"description", "value"=>"Sample Self Mailer", "datatype"=>"string"}, {"name"=>"to", "value"=>"adr_58088d858a815c66", "datatype"=>"string"}, {"name"=>"from", "value"=>"", "datatype"=>"null"}, {"name"=>"billing_group_id", "value"=>"", "datatype"=>"null"}, {"name"=>"send_date", "value"=>"2021-11-01", "datatype"=>"string"}, {"name"=>"inside", "value"=>"<html><body><h1>Hello World</h1></body></html>", "datatype"=>"string"}, {"name"=>"outside", "value"=>"<html><body><h1>Goodbye</h1></body></html>", "datatype"=>"string"}, {"name"=>"size", "value"=>"6x18_bifold", "datatype"=>"string"}, {"name"=>"mail_type", "value"=>"usps_first_class", "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 | string | 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":"sfm_8ffbe811dea49dcf","description":"April Campaign","metadata":{},"to":{"id":"adr_bae820679f3f536b","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-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","deleted":true,"object":"address"},"from":{"id":"adr_210a8d4b0b76d77b","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-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","deleted":true,"object":"address"},"url":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf.pdf?version=v1\u0026expires=1618512040\u0026signature=qvyCqXI1ndBvc4AjvG8FlirqLXEcfmYo4sDrRtabaXMOsX88to9G3K49uIk_aqevvZXe8HoRYD_nWydbQHqaCA","outside_template_id":"tmpl_a3cb937f26d7eec","inside_template_id":"tmpl_a3cb937f26d7eec","inside_template_version_id":"vrsn_bfdf70893b00a85","outside_template_version_id":"vrsn_bfdf70893b00a85","carrier":"USPS","tracking_events":[],"thumbnails":[{"small":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_small_1.png?version=v1\u0026expires=1618512040\u0026signature=-bipeUHP-hAMcCBSrWM0ZH1VwRdSPNVGGZN9hAZKr6Lh4ly6uxvratVd5LXJCK_zOEMYk_mTWASt0ge7OY6SDA","medium":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_medium_1.png?version=v1\u0026expires=1618512040\u0026signature=ryxN7bsXGtw_GRFSP3Cs3A3IYjxZi3cW9BHDCNgMt6p3nobVmsc_iFHt2e-S7ndAXhhN7nP-MQVov3bt3r37BQ","large":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_large_1.png?version=v1\u0026expires=1618512040\u0026signature=kBrm00xkyCkJNJRHxH8HshFaebtOxnzjVWOs1VVmGMuw8H6OBNcMAMxt9s49K0jlpHoh3Nr9uSncEZMQaaNjAg"},{"small":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_small_2.png?version=v1\u0026expires=1618512040\u0026signature=3gTgU7Fd3KoT_vNlQnTGptRps5ZgnkhSnPrAwk7L98higIzSwfKoLvuu_DIpMM48dHbxckKT9waR8euJ4KSDBQ","medium":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_medium_2.png?version=v1\u0026expires=1618512040\u0026signature=Ue1lw5CMj7KRx6cMQL8xPeazaHCdJzWcACd1w3acuYPnWkVIpSt62OIO7hAtpAQK9xm1dhhlFj0rqRZMdRMMBA","large":"https://lob-assets.com/self-mailers/sfm_8ffbe811dea49dcf_thumb_large_2.png?version=v1\u0026expires=1618512040\u0026signature=cICc7HEm1xG_eyM4a_wtvPk2FqoLRmtgGa29kJisWnMIYBL0OkyzG4ZCYGMhp-5cZpJlSpXfTgGKh_Qmeo1TDw"}],"merge_variables":{"name":null},"size":"6x18_bifold","mail_type":"usps_first_class","expected_delivery_date":"2021-03-24","date_created":"2021-03-16T18:40:40.504Z","date_modified":"2021-03-16T18:40:40.504Z","send_date":"2021-03-16T18:45:40.493Z","billing_group_id":"bg_79a178f7171f5795d","object":"self_mailer"}