Archive a team
Archives a team instead of deleting it, so its past visits keep its name. Archiving a team that is already
archived returns it unchanged. Bring it back with archived: false on update-team.
Scope: people:write · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>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.
Scope: people:write
team_id*stringThe team's ID.
^team_[0-7][0-9a-hjkmnp-tv-z]{25}$"team_01m4r6y616e1b973vj50h0643y"The team, now archived.
application/json- response
A team: who a visitor comes to see when it isn't one person, and who a waiting visitor is passed to.
id*TeamIdA team ID (TypeID with the team prefix).
^team_[0-7][0-9a-hjkmnp-tv-z]{25}$"team_01m4r6y616e1b973vj50h0643y"name*stringlength <= 80"Finance"site_id*|The site the team is at. null: every site.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$lead_id*|The person who leads the team, if you name one.
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$visitors_can_choose*booleanVisitors may choose this team at the kiosk and on your visitor pages.
archived*booleanAn archived team takes no new visits; its past visits keep its name.
members*array<>created_at*stringdate-timeupdated_at*stringdate-timecurl -X DELETE 'https://api.agoo.ardent.africa/v1/teams/team_01m4r6y616e1b973vj50h0643y'{ "id": "team_01m4r6y616e1b973vj50h0643y", "name": "Finance", "site_id": "string", "lead_id": "string", "visitors_can_choose": true, "archived": true, "members": [ { "id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "name": "string", "job_title": "string", "active": true } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Update a team PATCH
Changes a team's name, site, lead, whether visitors may choose it, or its members (`member_ids` replaces them). `archived: true` archives the team: it takes no new visits, and a visit waiting with it stays where it is until someone passes it on. **Scope:** `people:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Add members to a team POST
Adds people to a team. People already in it stay as they are. A team's members are the ones told about a visit for the team, and any of them can take it. **Scope:** `people:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.