Document PUT /my/profile.json endpoint#391
Conversation
The update profile endpoint exists in BC3 but was never documented, which caused it to be missed in the SDK generation pipeline.
There was a problem hiding this comment.
Pull request overview
Adds missing API documentation for updating the authenticated user’s profile (PUT /my/profile.json) so the People documentation covers the full set of supported “my profile” operations and can be picked up by downstream SDK/doc tooling.
Changes:
- Adds “Update my personal info” to the People endpoints list.
- Documents
PUT /my/profile.json, including optional parameters, expected status codes, and example JSON/cURL.
💡 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.
| ###### Example JSON Request | ||
|
|
||
| ```json |
There was a problem hiding this comment.
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.
| * `first_week_day` - the first day of the week (`0` for Sunday, `1` for Monday). | ||
| * `time_format` - time display format. |
There was a problem hiding this comment.
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.
| * `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`. |
| } | ||
| ``` | ||
| <!-- END PUT PAYLOAD /my/preferences.json --> | ||
|
|
There was a problem hiding this comment.
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.
Summary
PUT /my/profile.jsontosections/people.mdMy::ProfilesController#update) but was never documented, which caused it to be missed in the SDK generation pipelinename,email_address,title,bio,location,time_zone_name,first_week_day,time_format