{"id":3586,"date":"2023-08-29T19:34:10","date_gmt":"2023-08-29T18:34:10","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3586"},"modified":"2024-03-19T13:21:54","modified_gmt":"2024-03-19T12:21:54","slug":"send-trigger-messages","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-messages\/send-trigger-messages\/","title":{"rendered":"Send trigger messages"},"content":{"rendered":"\n

Triggers collection allows sending previously specified API-triggered message to a list of subscribers, using HTTP POST method. Specifying single message ID is required. At the moment, no other methods can be used on Triggers collection.<\/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>Trigger message ID. Required as a part of address (not GET parameter). See example below.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/Triggers\/123<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Data part of request for sending trigger message to subscribers.<\/p>\n\n\n\n
Data element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
xsi:type<\/td>–<\/td>Describes type of manipulated data. Value should always be \u201cTriggerReceivers\u201d for this request<\/td><\/tr>
Receivers<\/td>complex<\/td>Collection of subscribers that will receive the trigger message (Receiver elements).<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Receiver element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Id<\/td>integer<\/td>Subscriber\u2019s identifier. Optional. *<\/td><\/tr>
Email<\/td>string<\/td>Subscriber\u2019s email. Optional. <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
* Note: Either Id or Email field must be specified to identify the subscriber. If Email is specified, subscriber with this email must exist in the database. If both fields are specified, Id takes precedence.<\/p>\n\n\n\n
Subscribers that cannot be found in the database are ignored and will not receive the trigger message (no error message is returned).<\/p>\n\n\n\n
<\/a><\/a>Examples<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/Triggers\/123 HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: application\/xml <\/span><\/span>\nUser-Agent: Jakarta <\/span><\/span>\nCommons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 427 <\/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>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>TriggerReceivers<\/span>"<\/span>><\/span><\/span>\n       <\/span><<\/span>Receivers<\/span>><\/span><\/span>\n          <\/span><<\/span>Receiver<\/span>><\/span><\/span>\n             <\/span><<\/span>Id<\/span>><\/span>137384<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n          <\/span><\/<\/span>Receiver<\/span>><\/span><\/span>\n          <\/span><<\/span>Receiver<\/span>><\/span><\/span>\n             <\/span><<\/span>Email<\/span>><\/span>test@testtest.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n          <\/span><\/<\/span>Receiver<\/span>><\/span><\/span>\n       <\/span><\/<\/span>Receivers<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 201 Created <\/span><\/span>\nCache-Control: private <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=oxhfxmvpdfj1gz45mhxgx1jb; 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, 19 Jul 2010 17:08:43 GMT <\/span><\/span>\nContent-Length: 0<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Error response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 400 Bad Request <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nSet-Cookie: ASP.NET_SessionId=2xdqfo55sk0k53450qbwzj45; 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: Wed, 21 Jul 2010 13:10:09 GMT <\/span><\/span>\nContent-Length: 247 <\/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>ErrorMessage<\/span>><\/span><\/span>\n      <\/span><<\/span>Code<\/span>><\/span>400<\/span><\/<\/span>Code<\/span>><\/span><\/span>\n      <\/span><<\/span>Message<\/span>><\/span>Trigger is inactive or was deleted.<\/span><\/<\/span>Message<\/span>><\/span><\/span>\n   <\/span><\/<\/span>ErrorMessage<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3559,"menu_order":329,"template":"","format":"standard","emp-category":[],"class_list":["post-3586","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3586","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\/3586\/revisions"}],"predecessor-version":[{"id":8784,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3586\/revisions\/8784"}],"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=3586"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3586"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}