Docs

Update a project

Preview· P9
PATCH
/projects/{project_id}

Changes a project. Name the version you read: a stale one is version_stale (409), and nothing changes. A date moved here changes the plan, not what was agreed. Fires project.updated.

Scope: projects:write

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
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs 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 partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs 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: projects:write

Path Parameters

project_id*string
Match^proj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

version*integer

The version you read.

Formatint64
Range1 <= value

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

Request Body

application/json
  1. body

What a key may set on a project. On create, name and owner_person_id are needed.

name?string
Lengthlength <= 200
description?string
Lengthlength <= 2000
owner_person_id?PersonId

A person ID (TypeID with the person prefix).

Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"person_01kjsesxm0e4zbyvkr7bcfxbfg"
sponsor_person_id?PersonId

A person ID (TypeID with the person prefix).

Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"person_01kjsesxm0e4zbyvkr7bcfxbfg"
start_on?string
Formatdate
target_on?string
Formatdate
state?string

On create only.

Value in"proposed""active"

Response Body

The project.

application/json
  1. response

A project. Its tasks are ordinary tasks in its list: GET /tasks?container= reads them. What a person reported and what the data says are kept apart.

id*ProjectId
Match^proj_[0-7][0-9a-hjkmnp-tv-z]{25}$
container_id*string

The list its tasks live in.

name*string
description?string
visibility*string
Value in"members""org_readable"
state*ProjectState
Value in"proposed""approved""active""on_hold""completed""cancelled""archived"
state_reason?string
owner?

Who is accountable: id and name.

sponsor?

The sponsor: id and name.

client?

The client: kind, id and name.

start_on?string
Formatdate
target_on?string
Formatdate
closed_on?string
Formatdate
latest_update?

What the person responsible last said: id, as_of and health.

signals?

What the data says, computed: tasks done, late and blocked, and whether updates are current.

open_tasks?integer
Formatint64
limit_reached?boolean

The plan's active projects are all in use, so this one stays proposed.

version*integer
Formatint64
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
curl -X PATCH 'https://api.agoohq.com/v1/projects/string?version=1' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "container_id": "string",  "name": "string",  "description": "string",  "visibility": "members",  "state": "proposed",  "state_reason": "string",  "owner": {},  "sponsor": {},  "client": {},  "start_on": "2019-08-24",  "target_on": "2019-08-24",  "closed_on": "2019-08-24",  "latest_update": {},  "signals": {},  "open_tasks": 0,  "limit_reached": true,  "version": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}