Getting started
Introduction
The AnyoneIn API confirms deliveries and collections that need someone in, before the van leaves. Send an order, and get a signed webhook when the customer answers.
AnyoneIn is an AI agent that checks someone will be in before any delivery or collection that needs them: signed-for, age-verified, high-value, two-person, installs, collections and returns. You send it the order. It emails the customer, texts them if there's no reply, and finally makes a natural phone call. It reads whatever they reply, rebooks them into a slot you offered if they can't make it, and tells your system the result.
The API is small on purpose: one resource, the confirmation, and one webhook event, confirmation.updated.
- CreatePOST the customer, the items, the date and window, and the slots you can offer instead.
- PlanAnyoneIn schedules an email, then a text, then a call, inside sensible hours.
- ConverseThe customer replies in their own words. Any reply pauses the plan; a clear answer closes it.
- OutcomeYou get a signed
confirmation.updatedwebhook with the status and a one-line summary.
Base URL
All endpoints live under one base URL and speak JSON over HTTPS.
https://api.anyonein.co.uk/v1Note
api.anyonein.co.uk is a placeholder until the production domain is confirmed. The paths below won't change.
Endpoints
| Method | Path | What it does |
|---|---|---|
POST | /v1/confirmations | Create a confirmation and schedule its plan |
GET | /v1/confirmations/{id} | Retrieve one confirmation, with its full event history |
GET | /v1/confirmations | List recent confirmations, newest first |
POST | /v1/confirmations/{id}/advance | Send the next step now |
POST | /v1/confirmations/{id}/cancel | Stop the plan and close the confirmation |
Conventions
- JSON in, JSON out. Send
Content-Type: application/json. Every response is a JSON object:{ "confirmation": … },{ "confirmations": […] }, or{ "error": … }on failure. - Times are ISO 8601 in UTC, such as
2026-10-10T09:00:00.000Z. - Delivery dates and windows are local UK time: dates as
YYYY-MM-DD, windows as 24-hourHH:MM. Quiet hours are worked out inEurope/London. - Phone numbers can be sent in any common format. Numbers without a country code are treated as UK and stored in E.164, so
07700 900123becomes+447700900123. - IDs are opaque strings with a prefix:
cf_for confirmations,st_for steps andev_for events. - British English in every message the agent writes, unless your brand tone says otherwise.
Sandbox
In the sandbox, channels run as a simulator: nothing is sent to a real inbox or phone, and every step and event carries "live": false. You play the customer from the sandbox console, replying to the text or answering the simulated call, and the same outcomes and webhooks fire as in production. See the quickstart.
What's live today
The API documented here matches the working product. Anything that isn't built yet is marked Roadmap and left out of the reference.
| Capability | Status |
|---|---|
| Create, retrieve, list, advance and cancel confirmations | Available |
| Email, text (SMS), AI phone call; WhatsApp in place of SMS | Available. WhatsApp in production needs approved message templates |
Signed confirmation.updated webhooks | Available |
Branded customer page with one-tap answers (links.customer) | Available |
| Idempotency keys | Roadmap |
| Rate-limit headers, per-key limits (rate limits) | Roadmap |
| Webhook retries and replay protection (webhooks) | Roadmap |
| Pagination cursors and filters on the list endpoint | Roadmap |
| Prebuilt integrations such as Shopify or NetSuite (integrations) | Roadmap: use the API and webhooks today |
Next steps
- Quickstart: your first confirmation in three steps.
- The confirmation object: statuses, steps, events and outcomes.
- Webhooks: verify the signature and act on the result.
Base URL https://api.anyonein.co.uk/v1 is a placeholder until the production domain is confirmed. Found a mistake? Tell us.