---
title: "Update a project's brief"
method: PUT
path: "/api/v1/project-rooms/{id}/brief"
tags: ["Projects"]
---

# Update a project's brief

`PUT /api/v1/project-rooms/{id}/brief`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/brief`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `goal` string
  - `requirements` object[]
    - `id` string
    - `text` string, required
    - `standing` 'met' | 'unknown'

## Response `200`

Success

- object
  - `brief` object, required
    - `name` string, required
    - `intent` string, required
    - `goal` string, required
    - `iso` string, nullable, required
    - `marketStatus` 'unknown' | 'outside', nullable, required
    - `asset` object, nullable, required
      - `name` string, required
      - `key` string
      - `iso` string, required
    - `site` object, nullable, required
      - `name` string, required
      - `address` string
      - `location` unknown[], required
        - unknown
    - `market` object, required
      - `node` object
        - `value` string, required
        - `from` string, required
        - `confirmed` boolean, required
      - `hub` object
        - `value` string, required
        - `from` string, required
        - `confirmed` boolean, required
      - `loadZone` object
        - `value` string, required
        - `from` string, required
        - `confirmed` boolean, required
      - `poiBus` object
        - `value` string, required
        - `from` string, required
        - `confirmed` boolean, required
    - `datasets` object[], required
      - `id` string, required
      - `name` string, required
      - `source` string
      - `pack` string
      - `reason` string
    - `requirements` object[], required
      - `id` string, required
      - `text` string, required
      - `proposed` boolean, required
      - `standing` 'met' | 'at-risk' | 'unknown', required
      - `openFindings` string[], required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)