Skip to content

Document PUT /my/profile.json endpoint #391

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 3 commits into from
Mar 20, 2026
Merged

Document PUT /my/profile.json endpoint #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9b543f
Document PUT /my/profile.json endpoint
robzolkos Mar 12, 2026
797ae8b
Note GET and PUT support for /my/profile.json in README
robzolkos Mar 12, 2026
0bd56bd
Merge branch 'master' into add-update-my-profile-docs
jeremy Mar 20, 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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ The resource is called **person** (not user). Endpoints:
- `/people.json` — list people in account
- `/people/{id}.json` — single person
- `/projects/{id}/people.json` — people in a project
- `/my/profile.json` — current authenticated user
- `/my/profile.json` — current authenticated user (GET and PUT)

### To-do specifics

Expand Down
41 changes: 40 additions & 1 deletion sections/people.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Endpoints:
- [Get pingable people](#get-pingable-people)
- [Get person](#get-person)
- [Get my personal info](#get-my-personal-info)
- [Update my personal info](#update-my-personal-info)
- [Get my preferences](#get-my-preferences)
- [Update my preferences](#update-my-preferences)

Expand Down Expand Up @@ -272,6 +273,43 @@ curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCO
```


Update my personal info
-----------------------

* `PUT /my/profile.json` allows updating the current user's personal info.

**Optional parameters**:

* `name` - the user's display name.
* `email_address` - the user's email address.
* `title` - the user's job title.
* `bio` - a short bio.
* `location` - the user's location.
* `time_zone_name` - the user's time zone (e.g. `America/Chicago`).
* `first_week_day` - the first day of the week (`0` for Sunday, `1` for Monday).
* `time_format` - time display format.
Comment on lines +289 to +290
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

first_week_day and time_format are documented here with different/value-less guidance than the /my/preferences.json docs immediately below (which show first_week_day as weekday names and time_format as twelve_hour/twenty_four_hour). Please align the accepted values (or explicitly explain why /my/profile.json differs) to avoid conflicting instructions.

Suggested change
* `first_week_day` - the first day of the week (`0` for Sunday, `1` for Monday).
* `time_format` - time display format.
* `first_week_day` - the first day of the week using weekday names (one of `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`).
* `time_format` - time display format, either `twelve_hour` or `twenty_four_hour`.

Copilot uses AI. Check for mistakes.

This endpoint will return `204 No Content` if the update was a success. Returns `422 Unprocessable Entity` if the update fails (e.g. the email address is already in use).

###### Example JSON Request

```json
Comment on lines +294 to +296
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

The request example for this PUT endpoint is missing the usual <!-- START PUT PAYLOAD ... --> / <!-- END PUT PAYLOAD ... --> markers used elsewhere in this file (and other sections) around JSON request payloads. Adding those markers helps keep the docs consistent and supports tooling that extracts example payloads.

Copilot uses AI. Check for mistakes.
{
"name": "Victor Cooper",
"title": "Chief Strategist",
"bio": "Don't let your dreams be dreams",
"location": "Chicago, IL"
}
```
###### Copy as cURL

```shell
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"name":"Victor Cooper","title":"Chief Strategist"}' -X PUT \
https://3.basecampapi.com/$ACCOUNT_ID/my/profile.json
```


Get my preferences
------------------

Expand Down Expand Up @@ -321,6 +359,7 @@ Returns `200 OK` with the updated [preferences](#get-my-preferences) JSON repres
}
```
<!-- END PUT PAYLOAD /my/preferences.json -->

Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

There’s an extra blank line between the <!-- END PUT PAYLOAD /my/preferences.json --> marker and the ###### Copy as cURL heading. In this file, other payload blocks place ###### Copy as cURL immediately after the END marker, so removing the blank line would keep formatting consistent.

Suggested change

Copilot uses AI. Check for mistakes.
###### Copy as cURL

```shell
Expand All @@ -329,4 +368,4 @@ curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/j
https://3.basecampapi.com/$ACCOUNT_ID/my/preferences.json
```

[3]: https://github.com/basecamp/bc3-api/blob/master/sections/out_of_office.md#out-of-office
[3]: https://github.com/basecamp/bc3-api/blob/master/sections/out_of_office.md#out-of-office
Loading