API reference

Cancel a confirmation

Stops the plan, hangs up any live call and closes the confirmation as cancelled.

POST/v1/confirmations/{id}/cancel

Use this when the job itself has changed: the order was cancelled, the delivery was moved in your own system, or it was confirmed another way. Nothing more is sent to the customer.

curl -X POST https://api.anyonein.co.uk/v1/confirmations/cf_7d2a9c41e0b3f658/cancel \
  -H "Authorization: Bearer $ANYONEIN_KEY"

const res = await fetch(
  'https://api.anyonein.co.uk/v1/confirmations/cf_7d2a9c41e0b3f658/cancel',
  { method: 'POST', headers: { Authorization: `Bearer ${process.env.ANYONEIN_KEY}` } },
);
const { confirmation } = await res.json(); // confirmation.status === 'cancelled'

res = requests.post(
    "https://api.anyonein.co.uk/v1/confirmations/cf_7d2a9c41e0b3f658/cancel",
    headers={"Authorization": f"Bearer {os.environ['ANYONEIN_KEY']}"},
    timeout=15,
)
confirmation = res.json()["confirmation"]

<?php
$ch = curl_init('https://api.anyonein.co.uk/v1/confirmations/cf_7d2a9c41e0b3f658/cancel');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ANYONEIN_KEY')],
]);
$confirmation = json_decode(curl_exec($ch), true)['confirmation'];

Response200 OK

{
  "confirmation": {
    "id": "cf_7d2a9c41e0b3f658",
    "status": "cancelled",
    "outcome": null,
    "steps": [
      { "id": "st_4be1a09c", "channel": "email", "state": "sent", "sentAt": "2026-10-10T09:00:02.117Z" },
      { "id": "st_91c3d27e", "channel": "sms", "state": "cancelled" },
      { "id": "st_0a6f58b2", "channel": "call", "state": "cancelled" }
    ],
    "events": [
      { "id": "ev_94e2a7c1b0", "kind": "system", "text": "Cancelled by API." }
    ]
  }
}

Path parameters

idstringrequired: The confirmation's id.

Returns

200 OK with the updated confirmation:

status is cancelled and outcome stays as it was (usually null);
every pending step becomes cancelled;
a call in progress is hung up;
a system event records "Cancelled by API.";
a confirmation.updated webhook is sent, if you set a webhookUrl.

Errors

Status	`error`	When
`404`	`No confirmation with that id.`	The `id` doesn't exist
`409`	`This confirmation is already closed.`	It already has an outcome, or was already cancelled

A confirmation that has closed with an outcome can't be cancelled. If the job changes after that, update it in your own system; the customer has already had their answer.

Base URL https://api.anyonein.co.uk/v1 is a placeholder until the production domain is confirmed. Found a mistake? Tell us.

#Path parameters

#Returns

#Errors

Path parameters

Returns

Errors