Campaigns

Preview campaign content

POST/v1/campaigns/{id}/preview

Requires an API key with the campaigns:read scope. About keys and scopes

Renders the campaign content to HTML and plain text without sending anything, optionally against a specific contact so personalization tokens resolve. Use this to check a campaign before sending it.

Path parameters

idstringrequired: uuid

Request body

contactIdstringrequired

The contact whose values fill the merge tags.

uuid

Returns

Returns 200 OK with a CampaignEmailPreview in data. Otherwise returns an error; Errors lists every code and which to retry.

subjectstringrequired: The subject with merge tags filled in.
htmlstringrequired: The rendered HTML body.
textstringoptional: The rendered plain-text body.

curl -X POST https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/preview \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
  }'

const response = await fetch('https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/preview",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b"
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/preview", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": {
    "subject": "Your order is on its way",
    "html": "html_example",
    "text": "text_example"
  }
}

Example values are generated from the schema.