Record a delivery
/deliveriesRecords a parcel received at a site, for example from your own mailroom system. With notify_recipient
(the default), Agoo tells the recipient by their notification preferences. Fires delivery.received.
Scope: deliveries: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: deliveries:write
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/deliveries" \ -H "Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64" \ -H "Content-Type: application/json" \ -d '{ "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "recipient_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "sender": "Coastline Consult", "carrier": "Dispatch rider", "description": "Signed engagement letter", "package_count": 1, "notify_recipient": true }'{ "id": "delivery_01m4x0bj50e43vcf8bz0ar7qhp", "status": "received", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "recipient_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "sender": "Coastline Consult", "carrier": "Dispatch rider", "tracking_number": null, "description": "Signed engagement letter", "package_count": 1, "received_at": "2026-10-14T10:47:00Z", "received_by": null, "collected_at": null, "collected_by_name": null, "created_at": "2026-10-14T10:47:00Z", "updated_at": "2026-10-14T10:47:00Z"}List deliveries GET
Returns deliveries, newest first. Use `status=received` to see parcels still waiting at reception. **Scope:** `deliveries:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Mark a delivery as collected POST
Marks a `received` delivery as collected and fires `delivery.collected`. Leave `collected_by_name` out when the recipient collected it themselves. A delivery that is already collected returns `invalid_state`. **Scope:** `deliveries:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.