Teostatakse POST päringuga, kõik parameetrid annakse üle query string sisse.
https://api.quantumtec.eu/v1/email/bulk| Parameeter | Tähendus |
|---|---|
| Content-Type | application/json |
| Accept | application/json |
| X-ApiKey | API võti autoriseerimiseks |
Parameetrid saadetakse JSON formaadis.
| Parameeter | Formaat | Rakendamine | Kirjeldus |
|---|---|---|---|
| bulkId | string | Ei ole kohustuslik | Postituse ID. Kui mitte märkida siis määratakse automaatselt. |
| from | string | Kohustuslik | saatja e-posti aadress |
| text | string | Kohustuslik | kirja tekst (lihttekst või HTML) |
| subject | string | Kohustuslik | Kirja teema |
| replyTo | string | Ei ole kohustuslik | Vastamise aadress. Kirja vastus saadetakse sellele aadressile. |
| isHtml | boolean | Kohustuslik | Kui see on tõene, tõlgendatakse tekstivälja sisu HTML-vormingus |
| recipients | array | Kohustuslik | Saajate loend |
| recipients(to) | string | Kohustuslik | saaja e-posti aadress |
| recipients(messageId) | string | Ei ole kohustuslik | Märgitakse kliendi poolt juhul kui tekib vajadus kasutada enda sõnumite ID. Kui mitte märkida siis määratakse automaatselt. |
| attachments | array | Ei ole kohustuslik | Manuste saatmise suvandite komplekt |
| attachments(fileName) | string | Ei ole kohustuslik | Faili nimi |
| attachments(contentType) | string | Ei ole kohustuslik | Faili tüüp |
| attachments(data) | string | Ei ole kohustuslik | Fail |
| startTime | string | Ei ole kohustuslik | Postituse algusaeg. Märgitakse formaadis "2018-01-01T00:10:20.000Z", ajavöönd peab olema UTC. Kui mitte märkida siis postitus algab koheselt. |
Vastuseks päringule saadetakse andmekogum JSON formaadis.
| Parameeter | Kirjeldus |
|---|---|
| bulkId | Kampaania identifikaator |