{"id":3672,"date":"2023-08-30T08:13:10","date_gmt":"2023-08-30T07:13:10","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3672"},"modified":"2024-03-19T13:23:33","modified_gmt":"2024-03-19T12:23:33","slug":"create-footer","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/templates\/create-footer\/","title":{"rendered":"Create footer"},"content":{"rendered":"\n

Footers collection allows creating new footers. Created footers can then be used in any email messages.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Data part of request for creating a new footer.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>Name of footer. Required.<\/td><\/tr>
Html<\/td>string<\/td>HTML content of footer. The data should be enclosed in CDATA section for XML transport. See examples. Required.<\/td><\/tr>
Plain<\/td>string<\/td>Plain text content of footer. Required.<\/td><\/tr>
AmpHtml<\/td>string<\/td>AMP HTML content of footer. The data should be enclosed in CDATA section for XML transport. See examples. Optional. <\/td><\/tr>
IsDefault<\/td>boolean<\/td>If set to “true” (note the lowercase!), the new created footer will be used as default in all new email messages. Optional. If not specified, default will be set to “false”<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a><\/a>Response<\/strong><\/h3>\n\n\n\n

Method returns ID of created footer. ID can be used e.g. for creating new email messages.<\/p>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
(Data element content)<\/td>int<\/td>ID of created footer.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Creating new <\/strong>footer <\/strong>with default options<\/strong><\/p>\n\n\n\n

Request:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/Footers HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 278 <\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span>><\/span>   <\/span><\/span>\n    <\/span><<\/span>Name<\/span>><\/span>New footer<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n    <\/span><<\/span>Html<\/span>><\/span><![CDATA[<\/span><h2>Completely new footer<\/h2><\/span>]]><\/span><\/<\/span>Html<\/span>><\/span><\/span>\n    <\/span><<\/span>Plain<\/span>><\/span>Just my new plain footer<\/span><\/<\/span>Plain<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span> <\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 201 Created <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nX-AspNetMvc-Version: 3.0 <\/span><\/span>\nX-AspNet-Version: 4.0.30319 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Thu, 05 Apr 2012 15:25:57 GMT <\/span><\/span>\nContent-Length: 147 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span>33<\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Creating <\/strong>footer <\/strong>with full options<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/Footers HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 1983 <\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n <\/span><<\/span>ApiKey<\/span>><\/span>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Name<\/span>><\/span>New default footer<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n     <\/span><<\/span>Html<\/span>><\/span><![CDATA[<\/span><h2>Completely new default footer<\/h2><\/span>]]><\/span><\/<\/span>Html<\/span>><\/span><\/span>\n     <\/span><<\/span>Plain<\/span>><\/span>Just my new plain default footer<\/span><\/<\/span>Plain<\/span>><\/span><\/span>\n     <\/span><<\/span>IsDefault<\/span>><\/span>true<\/span><\/<\/span>IsDefault<\/span>><\/span><\/span>\n     <\/span><<\/span>AmpHtml<\/span>><\/span><![CDATA[<\/span> <!doctype html><\/span><\/span>\n              <html amp4email><\/span><\/span>\n              <head><\/span><\/span>\n              <meta charset="utf-8"><\/span><\/span>\n              <script async src="https:\/\/cdn.ampproject.org\/v0.js"><\/script><\/span><\/span>\n              <style amp4email-boilerplate>body{visibility:hidden}<\/style><\/span><\/span>\n              <\/head><\/span><\/span>\n              <body><\/span><\/span>\n              Amp default footer<\/span><\/span>\n<\/span>\n              Please use AMP markup if there is such like "amp-img" instead of "img"<\/span><\/span>\n<\/span>\n              <amp-img src="https:\/\/sites.google.com\/site\/expertsenderapiv2\/_\/rsrc\/1530873497175\/config\/Es- API.png.1530873496983.png"<\/span><\/span>\n             alt="Welcome"<\/span><\/span>\n             width="906"<\/span><\/span>\n             height="132"><\/span><\/span>\n             <\/amp-img><\/span><\/span>\n             <\/body><\/span><\/span>\n             <\/html><\/span><\/span>\n             <\/span>]]><\/span><\/<\/span>AmpHtml<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3666,"menu_order":294,"template":"","format":"standard","emp-category":[],"class_list":["post-3672","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3672","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3672\/revisions"}],"predecessor-version":[{"id":8821,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3672\/revisions\/8821"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3666"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3672"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3672"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}