Skicka e-post

Endpoint

Endpoint: POST emails

När du vill skicka e-postmeddelanden använder du dig av anrops-datatypen nedan.

Anrops-datatyp

I sin kärna behöver endpointen för e-postustkick följande värden:

{
    "senderName": "iP.1 Networks AB",
    "senderAddress": "info@ip1.se",
    "recipients": [
        "info@othercorp.com",
        "billing@othercorp.com"
    ],
    "subject": "Testmeddelande",
    "type": "Text",
    "body": "Detta är ett enkelt testmeddelande"
}

Detta anrop kommer att omgående att skicka ett e-postmeddelande till varje angiven mottagare med textinnehållet “Detta är ett enkelt testmeddelande” till med avsändaren “iP.1 Networks AB”.

senderName

Namnet som är kopplat till avsändaradressen. Kan vara vad som helst, max 64 tecken.

senderAddress

Avsändarens e-postadress som e-postmeddelandet kommer att skickas från. Alla giltiga e-postadresser för en registrerad och verifierad domän.

recipients

En mängd e-postadresser att skicka e-postmeddelandet till. Kräver att alla e-postadresser är giltiga.

subject

E-postmeddelandets ämnesrad. Max 78 tecken.

type

Vilken typ av e-post som ska skickas som avgör hur body-parametern används, beskrivningar nedan.

body

E-postinnehållet. Oformaterad text eller HTML beroende på vilken typ som används.

Utökad

Vissa kan kräva ytterligare funktioner som mall, schemalagd sändning, leveransrapporter och att kunna ange sin egen referens.

{
    "senderName": "Sample Corp",
    "senderAddress": "info@example.com",
    "recipients": {
        "info@othercorp.com": {
            "name": "Head Office",
            "text": "special"
        },
        "billing@othercorp.com": {},
        "default": {
            "name": "Office",
            "text": "plain"
        }
    },
    "subject": "Sample Email",
    "type": "Text",
    "body": "This is a sample email in {text} text to {name}",
    "priority": 1,
    "deliveryWindows": [
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        },
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        }
    ],
    "deliveryReportUrl": "https://api.example.com/email/deliveryreport",
    "reference": "A client reference",
    "tags": ["marketing", "ux", "design"]
}

recipients – templating

För att kunna använda vårt templating-system måste du konvertera din tidigare mottagaruppsättning till en dictionary av dictionaries. Den översta nivånyckeln är mottagarens e-postadress. Den andra nivånyckeln söks sedan efter i texten och ersätts sedan av den andra nivåns värde.

Om nyckelnamnet inte ingår kommer det att genereras genom att extrahera användardelen av e-postadressen. Detta mallvärde används som mottagarnamnet som är kopplat till den e-postadressen.

Standardnyckeln används för reservvärden för nycklar som saknas i en mottagare. Som den andra i exemplet.

priority

Om det är mycket viktigt för dig att dina meddelanden kommer fram snabbt och inte hindras av våra andra meddelanden i kön kan du prioritera högre. Att prioritera ett högre värde kommer dock att höja priset med 10 öre (0,01 EUR). Prioritet 1 är standard och är den lägsta prioritet som är tillgänglig, och prioritet 2 är den högsta tillgängliga prioriteten. Om det anges är 1 och 2 de enda giltiga värdena.

deliveryWindows

Om det finns ett behov av att schemalägga et utskick finns det möjlighet att göra det med våra leveranstidsfönster.

Du kan ha hur många fönster som helst. Detta gör att du kan skicka meddelanden vid specifika tider under flera dagar, t.ex. varje dag mellan 10:00 och 10:05 på vardagar.

Parsing

• null i fältet opens kommer att ersättas med aktuellt datum och tid.
• Om closes är null kommer fältet att sättas till 7 dagar (168 timmar efter värdet i fältet opens).

Anropet kommer att bli avvisade om det finns fönster som överlapar varandra.

Om inga fönster ges kommer vi att skapa ett fönster som kommer att tillämpa regeln ovan.

deliveryReportUrl

Om det tillhandahålls kommer rapporter om statusuppdateringar att skickas till denna URL via POST. Dessa rapporter är separata för varje meddelandemottagare och varje statusuppdatering. För ytterligare läsning om dessa rapporter, se Läs leveransrapporter

reference

Detta är en egenskap som gör att användaren av detta API kan ha sitt eget ID eller referens om lagring av iP.1:s genererade ID inte föredras.

Restrictions

• Får vara max 40 tecken
• Kan inte vara tom sträng eller blanksteg.

null är default-värde.

tags

En rad taggar som används för att kategorisera/sortera e-postmeddelandet bland dina andra e-postmeddelanden. När du listar partier kan du filtrera efter dessa.

Repons

Om anropet accepteras kommer API:et att returnera en sammanfattning för e-postmeddelandet, som kan hittas senare på den plats som anges av location header. För mer information om respons-datatypen, läs e-postdokumentationen.

Vi returnerar vårt svar innan vi har fått bekräftat att din kontoekonomi har bekräftats så prissammanfattningen kanske inte sätts.