Update a task
Changes a task. Name the version you read: a stale one is version_stale (409), and nothing changes. A date given as an empty string clears it.
Scope: tasks:write
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: tasks:write
task_id*string^task_[0-7][0-9a-hjkmnp-tv-z]{25}$version*integerThe version you read.
int641 <= valueIdempotency-Key*stringA 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.
uuidapplication/json- body
A task's fields. A date given as an empty string clears it. Quantities are decimal strings.
title?stringlength <= 500description?stringlength <= 20000acceptance?stringWhat done means.
length <= 5000container_id?stringWhich list. A key has to name one.
parent_id?stringA parent task. Subtasks go at most four levels deep.
owner_person_id?stringWhoever is accountable. Empty: nobody yet (triage).
priority?string"urgent""high""medium""low"status_category?stringWhere a new task starts.
"backlog""ready""in_progress"start_on?stringA calendar day, never an instant.
start_at?stringAn instant, with start_tz.
start_tz?stringlength <= 64due_on?stringA calendar day, never an instant.
due_at?stringAn instant, with due_tz.
due_tz?stringlength <= 64planned_finish_on?stringestimate_value?stringA decimal string.
estimate_unit?string"minutes""hours""days""points"""remaining_value?stringA decimal string.
required?booleanA parent can't finish while this is open.
tags?array<string>items <= 30why?stringWhy it's going to this person.
length <= 500client_id?stringYour id for this capture: sending it again finds the same task.
uuidThe task.
application/json- response
A task. A date is a day or an instant, never one pretending to be the other, and its state is a category with no ambiguous done flag.
id*TaskId^task_[0-7][0-9a-hjkmnp-tv-z]{25}$ref_no?integerint64title*stringdescription?stringacceptance?stringkind?string"task""approval""acknowledgement""checklist_item"parent_id?stringcontainer?The list it lives in: id, name, kind, visibility and workflow_id.
owner?Whoever is accountable: id and name. Absent in triage.
priority?string"urgent""high""medium""low"status?id, name (the organisation's own) and category (backlog, ready, in_progress, blocked, in_review, completed, cancelled).
start_on?stringdatedue_on?stringdatedue_at?stringdate-timedue_tz?stringtags?array<string>source?Where it came from, if anywhere.
completion_outcome?string"done""skipped""blocked""override""source_confirmed""cancelled"series_id?stringThe repeating task it's one occurrence of.
occurrence_key?stringIts identity in that series: the date in the series' time zone, or the task before it for one that repeats on completion.
version*integerName this when you change it.
int64created_at?stringdate-timeupdated_at?stringdate-timecurl -X PATCH 'https://api.agoohq.com/v1/tasks/string?version=1' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "ref_no": 0, "title": "string", "description": "string", "acceptance": "string", "kind": "task", "parent_id": "string", "container": {}, "owner": {}, "priority": "urgent", "status": {}, "start_on": "2019-08-24", "due_on": "2019-08-24", "due_at": "2019-08-24T14:15:22Z", "due_tz": "string", "tags": [ "string" ], "source": {}, "completion_outcome": "done", "series_id": "string", "occurrence_key": "string", "version": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Get a task GET
Returns one task. One the key can't see doesn't exist for it. **Scope:** `tasks:read`
Complete a task POST
Finishes a task, or asks its source to where the source owns the truth: only its answer completes the task. A second completion changes nothing. Fires `task.completed`. **Scope:** `tasks:write`