Skip to content

Document creating a dock tool by type #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremy merged 2 commits into from
Jul 22, 2026
Merged

Document creating a dock tool by type #413

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f366722
Document creating a dock tool by type
jeremy Jul 22, 2026
afcb662
Italicize Optional parameters heading for section consistency
jeremy Jul 22, 2026
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
14 changes: 8 additions & 6 deletions sections/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,21 @@ curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCO
Create a tool
-------------

* `POST /buckets/1/dock/tools.json` creates a new tool in the project with ID `1` by cloning an existing tool.
* `POST /buckets/1/dock/tools.json` adds a tool of a given type to the dock of the project with ID `1`.
Comment thread
jeremy marked this conversation as resolved.
Comment thread
jeremy marked this conversation as resolved.

**Required parameters**:
* `source_recording_id` - the ID of an existing tool to clone. This determines the type of the new tool.
* `title` - the name for the new tool.
* `tool_type` - the kind of tool to add. One of `Message::Board`, `Todoset`, `Vault`, `Schedule`, `Chat::Transcript`, `Kanban::Board`, `Questionnaire`, or `Inbox`.

This endpoint will return `201 Created` with the JSON representation of the new tool if successful.
_Optional parameters_:
* `title` - the name for the tool. When omitted, Basecamp chooses the title.

This endpoint will return `201 Created` with the JSON representation of the tool if successful. The response body matches [Get a tool](#get-a-tool).

###### Example JSON Request

```json
{
"source_recording_id": 1069479341,
"tool_type": "Chat::Transcript",
"title": "Q&A Chat"
}
```
Expand All @@ -104,7 +106,7 @@ This endpoint will return `201 Created` with the JSON representation of the new

```shell
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"source_recording_id":1069479341,"title":"Q&A Chat"}' \
-d '{"tool_type":"Chat::Transcript","title":"Q&A Chat"}' \
https://3.basecampapi.com/$ACCOUNT_ID/buckets/1/dock/tools.json
```

Expand Down