Cancel a visit
/visits/{visit_id}/cancelCancels a visit that is expected or awaiting_approval, so its pass stops working, and fires
visit.cancelled. With notify_visitor (the default), Agoo tells the visitor on the channels their pass
was sent on. Any other status returns invalid_state.
Scope: visits:write · Plan: Pro and Enterprise in live mode; every plan in test mode.
Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
In: header
Scope: visits:write
Path Parameters
The visit's ID.
^visit_[0-7][0-9a-hjkmnp-tv-z]{25}$"visit_01m4k5z4j0fxbte6sn6e8tpgza"Header Parameters
A UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/visits/visit_01m4k5z4j0fxbte6sn6e8tpgza/cancel" \ -H "Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64" \ -H "Content-Type: application/json" \ -d '{ "reason": "Meeting moved to next week.", "notify_visitor": true }'{ "id": "visit_01m4qne6m0fgjbj3tkcv9xjn5p", "status": "cancelled", "type": "meeting", "source": "invitation", "site_id": "site_01knvdere0f738bjjhnyhtyv2z", "gate_id": null, "host_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "visitor": { "id": "visitor_01krdtb870fxj8t6ntdtcxwdk5", "name": "Ama Owusu", "phone": "+233241234567", "email": "ama@coastline.example", "company": "Coastline Consult" }, "purpose": "Branch cash-handling walkthrough", "expected_at": "2026-10-15T13:00:00Z", "expected_until": "2026-10-15T15:00:00Z", "checked_in_at": null, "checked_out_at": null, "cancelled_at": "2026-10-13T18:45:00Z", "decision": null, "booking_id": null, "pass": { "channels": [ "sms" ], "last_sent_at": "2026-10-12T09:00:03Z" }, "custom_fields": {}, "created_at": "2026-10-12T09:00:00Z", "updated_at": "2026-10-13T18:45:00Z"}Deny a visit POST
Denies a visit that is `awaiting_approval` and fires `visit.denied`. Reception is told straight away. A visitor who hasn't arrived yet (a pre-registration) is told the visit can't go ahead. The optional reason is stored on the visit for reception and the audit trail; Agoo doesn't send it to the visitor. Any other status returns `invalid_state`. **Scope:** `visits:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Resend a visitor's pass POST
Sends the visitor their QR pass again, for example after they lose the message or you change the visit's times. Only `expected` visits have a pass to resend; any other status returns `invalid_state`. - Leave `channels` out to use the channels the pass was last sent on. - Fires `pass.sent`. Each message counts towards your SMS and WhatsApp allowance. - In test mode, messages go to the console's test outbox. **Scope:** `visits:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.