Campaigns

Check whether a campaign can send

GET/v1/campaigns/{id}/eligibility

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

Reports every blocker that would stop this campaign sending — unverified domain, empty audience, invalid content — without attempting a send. Campaign-wide blockers sit at the top; each selected channel reports its own reach and blockers. Sending is all or nothing, so one blocked channel sets every channel's sendableRecipientCount to 0. Call this before sending to turn a 409 into an actionable list. This is an estimate: it neither reserves quota nor guarantees delivery.

Path parameters

idstringrequired: uuid

Returns

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

campaignIdstring | nullrequired

null when checked before saving (POST /campaigns/eligibility).

uuid

checkedAtstringrequired

When the check ran.

date-time

audienceCountintegerrequired

Contacts in the audience, before any channel's exclusions.

min 0 · max 9007199254740991

blockersstring[]required

Blockers for the campaign as a whole.

issuesobject[]required

What the draft still lacks, exactly as sending would refuse it (DRAFT_INCOMPLETE).

2 child attributes

pathstringrequired: The field that is incomplete, such as content.email.
messagestringrequired: What is missing, in plain words.

channelsobject[]required

One entry per selected channel.

One of 2 shapes

Email channel

6 child attributes

channel"email"required

eligibleRecipientCountintegerrequired

Contacts reachable on this channel after the exclusions.

min 0 · max 9007199254740991

sendableRecipientCountintegerrequired

eligibleRecipientCount when nothing blocks the campaign anywhere, else 0.

min 0 · max 9007199254740991

blockersstring[]required

What stops the email channel sending.

excludedobjectrequired

Contacts left out of the audience, by reason.

4 child attributes

consentMissingintegerrequired

Contacts without email consent.

min 0 · max 9007199254740991

topicUnsubscribedintegerrequired

Consented, but the campaign's topic does not reach them.

min 0 · max 9007199254740991

suppressedintegerrequired

Contacts whose address is blocked, for example after a bounce.

min 0 · max 9007199254740991

missingEmailintegerrequired

Contacts with no email address.

min 0 · max 9007199254740991

senderVerifiedbooleanrequired

Whether the sender domain is verified.

Push channel

6 child attributes

channel"push"required

eligibleRecipientCountintegerrequired

Contacts reachable on this channel after the exclusions.

min 0 · max 9007199254740991

sendableRecipientCountintegerrequired

eligibleRecipientCount when nothing blocks the campaign anywhere, else 0.

min 0 · max 9007199254740991

blockersstring[]required

What stops the push channel sending.

excludedobjectrequired

Contacts left out of the audience, by reason.

4 child attributes

consentMissingintegerrequired

Contacts without push consent.

min 0 · max 9007199254740991

topicUnsubscribedintegerrequired

Consented, but the campaign's topic does not reach them.

min 0 · max 9007199254740991

suppressedintegerrequired

Contacts blocked from push.

min 0 · max 9007199254740991

missingInstallationintegerrequired

Contacts with no registered device.

min 0 · max 9007199254740991

applicationReadybooleanrequired

Whether the push app is set up to send.

curl https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/eligibility \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/eligibility', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

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

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/campaigns/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/eligibility", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	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": {
    "campaignId": "018f2a4e-6b1c-7d3e-9f40-3478765e5a6b",
    "checkedAt": "2030-03-14T09:30:00Z",
    "audienceCount": 0,
    "blockers": [
      "campaign_not_draft"
    ],
    "issues": [
      {
        "path": "path_example",
        "message": "message_example"
      }
    ],
    "channels": [
      {
        "channel": "email",
        "eligibleRecipientCount": 0,
        "sendableRecipientCount": 0,
        "blockers": [
          "missing_email_content"
        ],
        "excluded": {
          "consentMissing": 0,
          "topicUnsubscribed": 0,
          "suppressed": 0,
          "missingEmail": 0
        },
        "senderVerified": true
      }
    ]
  }
}

Example values are generated from the schema.