Email Batches – A group of email messages
Read a collection of email batches
Endpoint: GET emails
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.
Read a single email batch
Endpoint: GET emails/{emailId}
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.
The response data type
{ "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" } ] }
id
A unique ID for a specific email batch.
owner
The account number of the account that owns the email batch (For example, you).
senderName
The name associated with the sender address. Can be anything, max 64 characters
senderAddress
The sender email address from which the email will be sent. Any valid email address for a registered and verified domain.
subject
The email subject line. Max 78 characters.
body
The content of the email batch messages. Plain text or HTML depending on the type used.
type
The type of email to send that determines how the body parameter is used, descriptions below
| Value (type) | Description |
|---|---|
| Text | Unformatted email, the body is the entire email content |
| Hybrid | Plain text entered into our ready-made HTML template as a text box, the body is the text in the box |
| HTML | Full HTML email, body when a full HTML page |
priority
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 öre (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.
templated
Whether Tempalting was used or not.
reference
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.
deliveryReportUrl
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.
priceSummary
priceSummary.total 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.
priceSummary.currency Which currency total and average are entered in.
priceSummary.average The average price for a single message in the package.
messageSummary
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.
tags
An array of tags used to categorize/sort the email among your other emails. When listing batches, you can filter by these tags.
deliveryWindows
If there is a need to schedule a shipment in the future, it is possible to do so with our delivery time windows
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.