Skip to content

Add API documentation for account administratorship endpoints#403

Open
robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos:docs-account-administratorship-json
Open

Add API documentation for account administratorship endpoints#403
robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos:docs-account-administratorship-json

Conversation

@robzolkos
Copy link
Contributor

@robzolkos robzolkos commented Mar 23, 2026

Summary

Document the JSON account administratorship management endpoints added in https://github.com/basecamp/bc3/pull/10044

Changes

  • Add docs for POST /account/people/:person_id/administratorship.json
  • Add docs for DELETE /account/people/:person_id/administratorship.json
  • Note the administrator-only permission requirements
  • Document the returned Person JSON and admin flag behavior
  • Add cURL examples for both endpoints

Copilot AI review requested due to automatic review settings March 23, 2026 13:51
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for the account-level administratorship management endpoints introduced in bc3#10044, including permission requirements and example responses.

Changes:

  • Document POST /account/people/:person_id/administratorship.json (grant administratorship) with example response and cURL.
  • Document DELETE /account/people/:person_id/administratorship.json (revoke administratorship) with example response and cURL.
  • Add [person] reference link used by the new sections.

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants