Void a signing request
Stops a request nobody has finished signing, with a reason. Its links stop working at once. A sealed document can't be voided.
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 |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
agoo_ck_live_ | Check API key, live mode, for a Check API partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As above, answering only the published test values, never billed |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: signing:write
request_id*string^sign_[0-7][0-9a-hjkmnp-tv-z]{25}$application/json- body
reason*string3 <= length <= 300OK
application/json- response
completed_at?stringdate-timecreated_at*stringdate-timedeclined_at?stringdate-timedocuments*array<>|nullevents?array<>|nullexpires_at*stringdate-timeid*stringmessage?stringorder*stringperson?stringperson_id?stringsender?stringsent_at?stringdate-timesigners*array<>|nullsource_kind*stringstatus*string"checking""sent""sealing""completed""declined""voided""expired"title*stringtype_id?stringversion*integerint64visibility*stringvoid_reason?stringvoided_at?stringdate-timecurl -X POST 'https://api.agoohq.com/v1/signing-requests/string/void' \ -H 'Content-Type: application/json' \ -d '{ "reason": "string"}'{ "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "declined_at": "2019-08-24T14:15:22Z", "documents": [ { "byte_size": 0, "hr_document_id": "string", "id": "string", "pages": 0, "position": 0, "sealed": true, "sealed_byte_size": 0, "sha256": "string", "status": "string", "title": "string", "verify": null } ], "events": [ { "property1": null, "property2": null } ], "expires_at": "2019-08-24T14:15:22Z", "id": "string", "message": "string", "order": "string", "person": "string", "person_id": "string", "sender": "string", "sent_at": "2019-08-24T14:15:22Z", "signers": [ { "asked_at": "2019-08-24T14:15:22Z", "by_link": true, "channels": [ "string" ], "contact": "string", "decline_reason": "string", "id": "string", "last_reminded_at": "2019-08-24T14:15:22Z", "method": "string", "name": "string", "person_id": "string", "placements": null, "position": 0, "role": "string", "signed_at": "2019-08-24T14:15:22Z", "status": "string", "viewed_at": "2019-08-24T14:15:22Z" } ], "source_kind": "string", "status": "checking", "title": "string", "type_id": "string", "version": 0, "visibility": "string", "void_reason": "string", "voided_at": "2019-08-24T14:15:22Z"}Remind signers POST
Reminds whoever's turn it is, at most once an hour. Agoo also reminds them after 2 and 5 days.
List departments GET
Returns your organisation's departments by name, each with the department it sits under, its head, code, cost centre and how many active people are in it. Archived departments are left out unless you ask for them with `archived=true`. A person's `department` is the name of their department. **Scope:** `people:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.