Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation for the Account API endpoints and links it from the main endpoint index so API consumers can discover and use the new account read/rename functionality.
Changes:
- Add new
sections/account.mddocumentingGET /account.jsonandPUT /account/name.jsonwith example payloads and cURL. - Add “Account” to the API endpoint index in
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
sections/account.md |
New documentation for account retrieval and renaming endpoints, including example request/response bodies. |
README.md |
Adds the Account docs link to the endpoint index for discoverability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
jeremy
force-pushed
the
api-account-resource
branch
from
9c6c50c to
82c2a32
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * `GET /account.json` will return the account for the current access token. | ||
|
|
||
| The `logo` field is only present when the account has a logo configured. It is omitted entirely when no logo exists. | ||
|
|
||
| ###### Example JSON Response | ||
| <!-- START GET /account.json --> | ||
| ```json | ||
| { | ||
| "id": 1009501286, | ||
| "name": "Honcho Design", | ||
| "owner_name": "Victor Cooper", | ||
| "active": true, | ||
| "created_at": "2026-03-16T21:42:20.134Z", | ||
| "updated_at": "2026-03-16T21:57:21.050Z", | ||
| "trial": false, | ||
| "trial_ends_on": null, | ||
| "frozen": false, | ||
| "paused": false, |
| * `PUT /account/name.json` will rename the current account. Only account owners can use this endpoint — returns `403 Forbidden` for non-owners. | ||
|
|
||
| **Required parameters**: | ||
|
|
||
| * `name` - the new name for the account. Returns `400 Bad Request` when blank. |
Summary
sections/account.mddocumenting the account resourceGET /account.json— retrieve account details (owners see additionalfrozen/pausedfields)PUT /account/name.json— rename the account (owner only, 403 for non-owners, 422 for blank names)PUT /account/logo.json— upload or replace the account logo via multipart upload (admin/owner only, validates format and 5 MB size limit)DELETE /account/logo.json— remove the account logo (admin/owner only)See basecamp/bc3#9920, basecamp/bc3#9928