{"id":3674,"date":"2023-08-30T08:15:20","date_gmt":"2023-08-30T07:15:20","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3674"},"modified":"2024-03-19T13:23:34","modified_gmt":"2024-03-19T12:23:34","slug":"edit-header","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/templates\/edit-header\/","title":{"rendered":"Edit header"},"content":{"rendered":"\n

Allows to update any header. Any information that won’t be given in this request, won’t be updated.<\/p>\n\n\n\n

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

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

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
ID<\/td>integer<\/td>Header ID. Required as a part of address (not inside request body). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example URL (HTTP method: PUT):<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Headers\/3<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Data part of request for updating header.<\/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 header. Optional.<\/td><\/tr>
Html<\/td>string<\/td>HTML content of header. The data should be enclosed in CDATA section for XML transport. See examples. Optional.<\/td><\/tr>
Plain<\/td>string<\/td>Plain text content of header. Optional.<\/td><\/tr>
AmpHtml<\/td>string<\/td>AMP HTML content of header. 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 header 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
Response<\/strong><\/h3>\n\n\n\n
By default, response is empty and HTTP code “204 \u2013 No Content” is returned.<\/p>\n\n\n\n
<\/a><\/a>Examples<\/strong><\/h3>\n\n\n\n
Updating a header<\/strong><\/p>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
PUT https:\/\/api.esv2.com\/v2\/Api\/Headers HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nContent-Type: text\/xml;charset=UTF-8<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nContent-Length: 1727<\/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_key<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n <\/span><<\/span>Data<\/span>><\/span><\/span>\n  <\/span><<\/span>Name<\/span>><\/span>New name of header<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n  <\/span><<\/span>Html<\/span>><\/span><![CDATA[<\/span><h2>Completely new HTML of header<\/h2><\/span>]]><\/span><\/<\/span>Html<\/span>><\/span><\/span>\n  <\/span><<\/span>Plain<\/span>><\/span>Update of plain header<\/span><\/<\/span>Plain<\/span>><\/span><\/span>\n <\/span><\/<\/span>Data<\/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 204 No Content <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nDate: Tue, 27 Mar 2012 13:28:01 GMT <\/span><\/span>\nContent-Length: 0<\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3666,"menu_order":293,"template":"","format":"standard","emp-category":[],"class_list":["post-3674","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3674","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\/3674\/revisions"}],"predecessor-version":[{"id":8822,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3674\/revisions\/8822"}],"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=3674"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3674"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}