Skip to content
Open
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
58 changes: 58 additions & 0 deletions sections/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Endpoints:

- [Get account](#get-account)
- [Update account name](#update-account-name)
- [Grant account administratorship](#grant-account-administratorship)
- [Revoke account administratorship](#revoke-account-administratorship)
- [Update account logo](#update-account-logo)
- [Remove account logo](#remove-account-logo)

Expand Down Expand Up @@ -128,6 +130,60 @@ curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
https://3.basecampapi.com/$ACCOUNT_ID/account/name.json
```

Grant account administratorship
-------------------------------

* `POST /account/people/2/administratorship.json` will make the person with ID `2` an account administrator. To promote a different person, replace `2` in the URL path with that person's ID. Only account administrators can use this endpoint. Clients cannot be made administrators.

Returns `200 OK` with the updated [person][person] JSON representation. On success, the response will have `"admin": true`.

###### Example JSON Response
<!-- START POST /account/people/2/administratorship.json -->
```json
{
"id": 1049715915,
"name": "Amy Rivera",
"email_address": "amy@honchodesign.com",
"admin": true
}
```
<!-- END POST /account/people/2/administratorship.json -->

###### Copy as cURL

```shell
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
-X POST \
https://3.basecampapi.com/$ACCOUNT_ID/account/people/2/administratorship.json
```

Revoke account administratorship
--------------------------------

* `DELETE /account/people/:person_id/administratorship.json` will remove account administratorship from the person identified by `:person_id` in the URL path. Only account administrators can use this endpoint. Account owners cannot have administratorship revoked through this endpoint.

Returns `200 OK` with the updated [person][person] JSON representation. On success, the response will have `"admin": false`.

###### Example JSON Response
<!-- START DELETE /account/people/2/administratorship.json -->
```json
{
"id": 1049715915,
"name": "Amy Rivera",
"email_address": "amy@honchodesign.com",
"admin": false
}
```
<!-- END DELETE /account/people/2/administratorship.json -->

###### Copy as cURL

```shell
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
-X DELETE \
https://3.basecampapi.com/$ACCOUNT_ID/account/people/2/administratorship.json
```

Update account logo
-------------------

Expand Down Expand Up @@ -164,3 +220,5 @@ curl -s -H "Authorization: Bearer $ACCESS_TOKEN" \
-X DELETE \
https://3.basecampapi.com/$ACCOUNT_ID/account/logo.json
```

[person]: https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-person