{"id":3597,"date":"2023-08-29T20:29:36","date_gmt":"2023-08-29T19:29:36","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3597"},"modified":"2024-03-19T13:21:57","modified_gmt":"2024-03-19T12:21:57","slug":"get-active-transactionals","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-messages\/get-active-transactionals\/","title":{"rendered":"Get active transactionals"},"content":{"rendered":"\n

ActiveTransactionals collection allows retrieving all defined transactional messages including currently unsent messages.<\/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>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/ActiveTransactionals?apiKey=YOUR_API_KEY_HERE<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Transactionals<\/td>array[complex]<\/td>Array of Transactional elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Transactional element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>int<\/td>Transactional identifier.<\/td><\/tr>
Tags<\/td>array[string]<\/td>Array of Tag elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Tag element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Tag<\/td>string<\/td>Name of message tag<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET <\/span><\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/ActiveTransactionals?apiKey=test_api_key1 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 22 Jan 2018 12:56:22 GMT <\/span><\/span>\nContent-Length: 480<\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Transactionals<\/span>><\/span><\/span>\n       <\/span><<\/span>Transactional<\/span>><\/span><\/span>\n         <\/span><<\/span>Id<\/span>><\/span>23<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n         <\/span><<\/span>Tags<\/span>><\/span><\/span>\n           <\/span><<\/span>Tag<\/span>><\/span>tag_1<\/span><\/<\/span>Tag<\/span>><\/span><\/span>\n           <\/span><<\/span>Tag<\/span>><\/span>tag_5<\/span><\/<\/span>Tag<\/span>><\/span><\/span>\n         <\/span><\/<\/span>Tags<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Transactional<\/span>><\/span><\/span>\n       <\/span><<\/span>Transactional<\/span>><\/span><\/span>\n         <\/span><<\/span>ID<\/span>><\/span>256<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n         <\/span><<\/span>Tags<\/span>><\/span><\/span>\n           <\/span><<\/span>Tag<\/span>><\/span>tag_2<\/span><\/<\/span>Tag<\/span>><\/span><\/span>\n         <\/span><\/<\/span>Tags<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Transactional<\/span>><\/span><\/span>\n       <\/span><<\/span>Transactional<\/span>><\/span><\/span>\n         <\/span><<\/span>Id<\/span>><\/span>345<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n         <\/span><<\/span>Tags<\/span>\/><\/span><\/span>\n       <\/span><\/<\/span>Transactional<\/span>><\/span><\/span>\n     <\/span><\/<\/span>Transactionals<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK Response when in the specified Business Unit hasn’t active transactional message:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nContent-Encoding: gzip <\/span><\/span>\nVary: Accept-Encoding <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=cu23cqm125fq1qih1kg4ux45; path=\/; HttpOnly <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Mon, 22 Jan 2018 12:56:22 GMT <\/span><\/span>\nContent-Length: 177 <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n     <\/span><<\/span>Transactionals<\/span> \/><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3559,"menu_order":324,"template":"","format":"standard","emp-category":[],"class_list":["post-3597","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3597","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\/3597\/revisions"}],"predecessor-version":[{"id":8789,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3597\/revisions\/8789"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3559"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3597"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3597"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}