Med API kan ni skapa, koppla ihop och schemalägga e-postkampanjer i Rules kampanjredigerare direkt från ert eget system.

Här byggs kampanjen upp av flera separata delar: en mall, en kampanj och ett meddelande. Dessa kopplas sedan ihop innan kampanjen schemaläggs för utskick.

Innan ni börjar behöver ni ha följande redo:

För att skapa och schemalägga en kampanj behöver ni genomföra följande fem steg i angiven ordning:

Varje steg använder ett id som returneras i ett tidigare steg: mallens id och meddelandets id används i dynamic set, och kampanjens id används i meddelandet och i requesten för schemaläggning.

Börja med att skapa en mall via endpointen New Editor – Template.

Mallen definierar e-postmeddelandets struktur och layout. Mallar i den nya redigeraren byggs med RCML (Rule Content Markup Language), som används för att definiera innehållet och strukturen i e-postmeddelandet.

Se dokumentationen för mer information om hur ni skapar mallar och arbetar med RCML.

Spara mallens id från svaret. Ni behöver det i steg 4.

När mallen är skapad är nästa steg att skapa en kampanj via endpointen New Editor – Campaign.

Kampanjen innehåller inställningar för utskicket, bland annat vilka mottagare som ska ta emot e-postmeddelandet.

Följ dessa steg:

Spara kampanjens id från svaret. Ni använder det i steg 3 och 5.

Skapa därefter ett meddelande via endpointen New Editor – Message.

Meddelandet innehåller själva e-postinnehållet och skapas separat från kampanjen.

Det innebär att kampanjen och dess innehåll hanteras som två olika delar som sedan kopplas ihop i nästa steg.

I requesten anger ni kampanjens id från steg 2 som dispatcher, med type: "campaign". Spara meddelandets id från svaret.

När både mallen och meddelandet har skapats behöver ni koppla ihop dem.

Skapa en variant (ett dynamic set) via endpointen New Editor – Dynamic Set.

Det kopplar samman meddelandet med mallen så att kampanjen använder rätt innehåll och layout vid utskicket.

Skicka med meddelandets id från steg 3 som message_id och mallens id från steg 1 som template_id.

När samtliga föregående steg är slutförda kan ni schemalägga kampanjen för utskick via endpointen Campaign Schedule.

Detta är det sista steget i processen och görs när kampanjen är färdigkonfigurerad.

Använd kampanjens id från steg 2 i endpointens sökväg.

Kan jag fortfarande använda API v2?

API v2-metoderna för transaktionsmeddelanden fungerar fortfarande. Den kommer i framtiden stängas ner och vi rekommenderar därför att byta till denna nya version redan nu.

Varför skapas meddelandet separat från kampanjen?

Kampanjen hanterar inställningar för utskicket, exempelvis mottagare, medan meddelandet innehåller själva e-postinnehållet.

Genom att skapa dessa separat kan de sedan kopplas ihop med en mall genom att skapa en variant (ett dynamic set) via New Editor – Dynamic Set.