Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sections/my_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,9 @@ Mark as read

**Required parameters**:

* `readables` - an array of `readable_sgid` values from the notifications response. These identify the items to mark as read.
* `readables` - an array of `readable_sgid` values from the notifications response. These identify the items to mark as read. At most 500 per request.

Returns `200 OK` on success with no body.
Returns `200 OK` on success with no body, or `422 Unprocessable Entity` when `readables` exceeds 500 items.

###### Example JSON Request

Expand Down
13 changes: 10 additions & 3 deletions sections/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,23 +295,30 @@ Create a Project Construction

To create a project given a template, you need to create a project construction.

* `POST /templates/:template_id/project_constructions.json` with at least a project `name`, and optionally a `description`.
* `POST /templates/:template_id/project_constructions.json` with at least a project `name`, and optionally a `description` and a `start_date`.

The parameters are nested under `project`:

* `name` - the name of the new project. Required.
* `description` - a description for the new project.
* `start_date` - date (ISO 8601) the new project starts on. A template's dates (to-do start and due dates, to-do subtask and card step due dates, card due dates, schedule entries) are relative to the start of its first week, and weeks in templates start on a Sunday, so the new project's dates are anchored to the Sunday on or before `start_date`. Omit it and they are anchored to the week in which the construction is processed, which is the week it was requested unless the construction is delayed across a Sunday.
Comment on lines +300 to +304

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Separate required and optional parameters

Replace this generic parameter list with the repository-standard **Required parameters**: and _Optional parameters_: blocks. Appending “Required” only to name breaks the documented section format and makes requiredness less scannable than every endpoint's consistent headings.

AGENTS.md reference: AGENTS.md:L38-L47

Useful? React with 👍 / 👎.


###### Example JSON Request

```json
{
"project": {
"name": "Marketing ",
"description": "2016-2017 Strategy"
"description": "2016-2017 Strategy",
"start_date": "2016-09-04"
}
}
```

###### Copy as cURL

```shell
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" -d '{"project":{"name":"Marketing Campaign","description":"For Client: Xyz Corp Conference"}}' -X POST \
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" -d '{"project":{"name":"Marketing Campaign","description":"For Client: Xyz Corp Conference","start_date":"2016-09-04"}}' -X POST \
https://3.basecampapi.com/$ACCOUNT_ID/templates/2085958507/project_constructions.json
```

Expand Down