{"id":3935,"date":"2024-11-18T09:22:05","date_gmt":"2024-11-18T09:22:05","guid":{"rendered":"http:\/\/34.88.191.99\/?page_id=3935"},"modified":"2025-04-07T13:54:00","modified_gmt":"2025-04-07T13:54:00","slug":"las-e-post-batches","status":"publish","type":"page","link":"https:\/\/ip1sms.com\/en\/developer\/las-e-post-batches\/","title":{"rendered":"Read email batches"},"content":{"rendered":"

Email Batches \u2013 A group of email messages<\/h1>\n\n\n\n

Read a collection of email batches<\/h2>\n\n\n\n

Endpoint: GET emails<\/code><\/p>\n\n\n\n

This endpoint provides you with a collection of email batches for which you can see the email document definition below. However, MessageSummary and PriceSummary will not be provided because they are only available to that endpoint for individual messages in an email batch. Arranged chronologically by date of creation.<\/p>\n\n\n\n

Read a single email batch<\/h2>\n\n\n\n

Endpoint: GET emails\/{emailId}<\/code><\/p>\n\n\n\n

This endpoint will give you single email batch which will give you the total cost of an email as well as a summary of the status of the emails.<\/p>\n\n\n\n

The response data type<\/h2>\n\n\n
\n{ "id": "5bc86b6e85c7209830f96936", "owner": "ip1-XXXXX", "senderName": "Sample Corp", "senderAddress": "info@example.com", "subject": "Sample Email", " body": "This is a sample email in {text} text to {name}", "type": "Text", "priority": 1, "templated": true, "reference": "A client reference", "deliveryReportUrl": "https:\/\/api.example.com\/email\/deliveryreport", "priceSummary": { "total": 1.88, "currency": "EUR", "average": 0.01 }, "messageSummary": { "101": { "messages": 43 }, "102": { "messages": 3 }, "201": { "messages": 142 } }, "tags": ["marketing", "ux" , "design"], "deliveryWindows": [ { "opens": "ISO-8601 string", "closes": "ISO-8601 string" }, { "opens": "ISO-8601 string", "closes" : "ISO-8601 string" } ] }\n\n<\/pre><\/div>\n\n\n
id<\/h3>\n\n\n\n
A unique ID for a specific email batch.<\/p>\n\n\n\n
owner<\/h3>\n\n\n\n
The account number of the account that owns the email batch (For example, you).<\/p>\n\n\n\n
senderName<\/h3>\n\n\n\n
The name associated with the sender address. Can be anything, max 64 characters<\/p>\n\n\n\n
senderAddress<\/h3>\n\n\n\n
The sender email address from which the email will be sent. Any valid email address for a registered and verified domain.<\/p>\n\n\n\n
subject<\/h3>\n\n\n\n
The email subject line. Max 78 characters.<\/p>\n\n\n\n
body<\/h3>\n\n\n\n
The content of the email batch messages. Plain text or HTML depending on the type used.<\/p>\n\n\n\n
type<\/h3>\n\n\n\n
The type of email to send that determines how the body parameter is used, descriptions below<\/p>\n\n\n\n
Value (type)<\/th>Description<\/th><\/tr><\/thead>
Text<\/td>Unformatted email, the body is the entire email content<\/td><\/tr>
Hybrid<\/td>Plain text entered into our ready-made HTML template as a text box, the body is the text in the box<\/td><\/tr>
HTML<\/td>Full HTML email, body when a full HTML page<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
priority<\/h3>\n\n\n\n
If it is very important to you that your messages arrive quickly and are not obstructed by our other messages in the queue, you can prioritize higher. However, prioritizing a higher value will increase the price by 10 \u00f6re (0.01 EUR). Priority 1 is the default and is the lowest priority available, and priority 2 is the highest priority available. If specified, 1 and 2 are the only valid values.<\/p>\n\n\n\n
templated<\/h3>\n\n\n\n
Whether Tempalting was used or not.<\/p>\n\n\n\n
reference<\/h3>\n\n\n\n
This is a feature that allows the user of this API to have their own ID or credential if storing the iP.1's generated ID is not preferred.<\/p>\n\n\n\n
deliveryReportUrl<\/h3>\n\n\n\n
If provided, status update reports will be sent to this URL via POST. These reports are separate for each message recipient and each status update. For more information about these reports, see Receive delivery reports.<\/p>\n\n\n\n
priceSummary<\/h3>\n\n\n\n
priceSummary.total<\/strong> The total price of the email. This value may change if messages are rejected by the next upstream operator in which case the payment for that specific message will be cancelled.<\/p>\n\n\n\n
priceSummary.currency<\/strong> Which currency total and average are entered in.<\/p>\n\n\n\n
priceSummary.average<\/strong> The average price for a single message in the package.<\/p>\n\n\n\n
messageSummary<\/h3>\n\n\n\n
This is a dictionary where the key is a status code and the value is the number of messages that have the last added status code. For more information about our message status codes, see our Status Codes section.<\/p>\n\n\n\n
tags<\/h3>\n\n\n\n
An array of tags used to categorize\/sort the email among your other emails. When listing batches, you can filter by these tags.<\/p>\n\n\n\n
deliveryWindows<\/h3>\n\n\n\n
If there is a need to schedule a shipment in the future, it is possible to do so with our delivery time windows<\/p>\n\n\n\n
You can have as many windows as you like. This allows you to send messages at specific times over several days, e.g. every day between 10:00 and 10:05 on weekdays.<\/p>","protected":false},"excerpt":{"rendered":"
E-postbatcher – En grupp av e-postmeddelanden L\u00e4sa en samling av e-postbatcher Endpoint: GET emails Den h\u00e4r endpointen ger dig en samling e-postbatcher f\u00f6r vilka du kan se e-post dokument-definitionen nedan. MessageSummary och PriceSummary kommer dock inte att tillhandah\u00e5llas eftersom de endast \u00e4r tillg\u00e4ngliga f\u00f6r den endpointen f\u00f6r enskilda meddelanden i en e-postbatch. Ordnad kronologiskt efter […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":382,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"developer-email.php","meta":{"footnotes":""},"categories":[4],"tags":[],"class_list":["post-3935","page","type-page","status-publish","hentry","category-api-dokumention"],"_links":{"self":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/3935","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/comments?post=3935"}],"version-history":[{"count":0,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/3935\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/pages\/382"}],"wp:attachment":[{"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/media?parent=3935"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/categories?post=3935"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ip1sms.com\/en\/wp-json\/wp\/v2\/tags?post=3935"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}