Docs
API referenceRoll calls

Close a roll call

Preview· P9
POST
/roll-calls/{rollcall_id}/close

Closes an active roll call and fires roll_call.closed. The final counts and list are kept for your records. A roll call that is already closed returns invalid_state.

Scope: rollcalls:write · Plan: Pro and Enterprise in live mode; every plan in test mode.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs 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.

Scope: rollcalls:write

Path Parameters

rollcall_id*string

The roll call's ID.

Match^rollcall_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"rollcall_01m4x13bw0fjmr5ekjkshzkke6"

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Response Body

The roll call, now closed.

application/json
  1. response

An emergency or drill roll call at one site.

id*RollCallId

A roll call ID (TypeID with the rollcall prefix).

Match^rollcall_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"rollcall_01m4x13bw0fjmr5ekjkshzkke6"
site_id*SiteId

A site ID (TypeID with the site prefix).

Match^site_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"site_01kjpt3yw0fz0v414608h9x65s"
kind*string
Value in"drill""emergency"
status*RollCallStatus
Value in"active""closed"
message*|

The message sent with the "I'm safe" link.

counts*
started_at*string
Formatdate-time
started_by*|

The person who started it. null when started with an API key.

Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
closed_at*|
Formatdate-time
closed_by*|
Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
curl -X POST 'https://api.agoohq.com/v1/roll-calls/rollcall_01m4x13bw0fjmr5ekjkshzkke6/close' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64'
{  "id": "rollcall_01m4x13bw0fjmr5ekjkshzkke6",  "site_id": "site_01kjpt3yw0fz0v414608h9x65s",  "kind": "drill",  "status": "closed",  "message": "Fire drill. Leave by the nearest exit and go to the car park assembly point.",  "counts": {    "total": 46,    "accounted_for": 46,    "missing": 0  },  "started_at": "2026-10-14T11:00:00Z",  "started_by": "person_01kjsexjt0e9rt8r69a60jzx03",  "closed_at": "2026-10-14T11:20:41Z",  "closed_by": null}