Transactional

Cancel a timed send

POST/v1/transactional/messages/{id}/cancel

Requires an API key with the transactional:send scope. About keys and scopes

Stops a message sent with sendAt before it goes: it becomes skipped with reason cancelled, and message.skipped is published. Once a worker has started sending it, the answer is 409 CONFLICT. Agent keys are refused with 403.

Path parameters

idstringrequired: uuid

Returns

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

idstringrequired

uuid

contactIdstring | nullrequired

Null when the contact was erased, or the message passed the retention period: the message no longer names anyone.

uuid

recipientAddressstring | nullrequired

The address an email went to, frozen at its first attempt; null for push, and until then.

channelstringrequired

one of email, push

statusstringrequired

one of queued, sending, skipped, sent, failed, delivered, bounced, complained

failureReasonstring | nullrequired

Why it failed or was skipped, e.g. suppressed, consent_missing, provider_rejected.

correlationIdstring | nullrequired

The correlationId given when it was sent, if any.

templateobject | nullrequired

The stored template and published version it was sent from; null for inline content. Messages sent before template versions carry version: null.

2 child attributes

idstringrequired: uuid
versioninteger | nullrequired: min > 0 · max 9007199254740991

createdAtstringrequired

date-time

sendAtstring | nullrequired

When a timed email goes out; null when it went at once.

date-time

sentAtstring | nullrequired

When it was handed to the provider.

date-time

deliveredAtstring | nullrequired

When the provider confirmed delivery.

date-time

failedAtstring | nullrequired

When it failed or was skipped (a cancelled send included).

date-time

openedAtstring | nullrequired

First open; only with tracking.opens.

date-time

clickedAtstring | nullrequired

First click; only with tracking.clicks.

date-time

curl -X POST https://api.kirora.io/v1/transactional/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel \
  -H "Authorization: Bearer $KIRORA_API_KEY"

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

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/transactional/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel",
    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("POST", "https://api.kirora.io/v1/transactional/messages/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/cancel", 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": {
    "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
    "contactId": "018f2a4e-6b1c-7d3e-9f40-4db757ce5a6b",
    "recipientAddress": "recipientAddress_example",
    "channel": "email",
    "status": "queued",
    "failureReason": "failureReason_example",
    "correlationId": "order-1001",
    "template": {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "version": 1
    },
    "createdAt": "2030-03-14T09:30:00Z",
    "sendAt": "2030-03-14T09:30:00Z",
    "sentAt": "2030-03-14T09:30:00Z",
    "deliveredAt": "2030-03-14T09:30:00Z",
    "failedAt": "2030-03-14T09:30:00Z",
    "openedAt": "2030-03-14T09:30:00Z",
    "clickedAt": "2030-03-14T09:30:00Z"
  }
}

Example values are generated from the schema.