Schedule entries: participants are only replaced when addressed - #424
Merged
Conversation
Document that PUT to a schedule entry leaves participants untouched when participant_ids is omitted, and clears them when an empty array is sent.
There was a problem hiding this comment.
Pull request overview
Updates the Basecamp API documentation to clarify PUT /schedule_entries/:id.json participant update semantics so integrations don’t unintentionally overwrite participants when participant_ids is omitted (consistent with this being a sync from bc3 doc/api/).
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.
Changes:
- Documented that omitting
participant_idspreserves existing participants on schedule entry updates. - Documented that sending
"participant_ids": []clears all participants.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating a schedule entry no longer clobbers participants by default:
PUTrequests that omitparticipant_idskeep the entry's current participants, and sending"participant_ids": []removes them all. The Update a schedule entry docs now say so.Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.