Skip to content

Enhance booking appointment update documentation examples#9854

Merged
Danipocket merged 2 commits intomicrosoftgraph:mainfrom
dylanstetts:patch-12
Apr 13, 2026
Merged

Enhance booking appointment update documentation examples#9854
Danipocket merged 2 commits intomicrosoftgraph:mainfrom
dylanstetts:patch-12

Conversation

@dylanstetts
Copy link
Copy Markdown
Contributor

Added examples for updating customers

Important

Required for API changes:

  • [] Link to API.md file: api-reference/v1.0/api/bookingappointment-update.md
  • [] Link to PR for public-facing schema changes (schema-Prod-beta/v1.0.csdl): N/A — no schema changes; documentation-only update adding a new example.
  • [] Attach the documentation plan generated for AI-assisted docs authoring and validation to help speed up content review.

Add other supporting information, such as a description of the PR changes:

Summary: Adds a second example to the Update bookingAppointment documentation showing how to update the customers array on a multi-customer appointment via PATCH.

What changed:

  • Renamed the existing example to Example 1: Change the date of service
  • Added Example 2: Update the customers for an appointment with a validated PATCH payload that updates the customers array with two bookingCustomerInformation entries
  • Added notes clarifying requirements that are not currently documented:
  1. @odata.type set to #microsoft.graph.bookingCustomerInformation is required on each customer object in the array — omitting it causes the request to fail
  2. Customer details (name, emailAddress, phone) should be included alongside customerId — the API does not auto-populate these fields from the customer record
  3. The customers array is a full replacement — all customers must be included, not just new additions
  4. The associated bookingService must have maximumAttendeesCount > 1

Why: A customer filed a support case reporting they could not add a second customer to a Bookings appointment via PATCH. The existing documentation only contains a date-change example and does not show a customers array update. The payload requirements (especially the mandatory @odata.type on each entry) are not documented, and AI assistants (including Copilot) were giving incorrect guidance (e.g., suggesting filledAttendeesCount must be manually updated, or that only customerId should be sent). The new example and notes were validated against the live API.


Important

The following guidance is for Microsoft employees only. Community contributors can ignore this message; our content team will manage the status.

After you've created your PR, expand this section for tips and additional instructions.
  • do not merge is the default PR status and is automatically added to all open PRs that don't have the ready to merge label.
  • Add the ready for content review label to start a review. Only PRs that have met the minimum requirements for content review and have this label are reviewed.
  • If your content reviewer requests changes, review the feedback and address accordingly as soon as possible to keep your pull request moving forward. After you address the feedback, remove the changes requested label, add the review feedback addressed label, and select the Re-request review icon next to the content reviewer's alias. If you can't add labels, add a comment with #feedback-addressed to the pull request.
  • After the content review is complete, your reviewer will add the content review complete label. When the updates in this PR are ready for external customers to use, replace the do not merge label with ready to merge and the PR will be merged within 24 working hours.
  • Pull requests that are inactive for more than 6 weeks will be automatically closed. Before that, you receive reminders at 2 weeks, 4 weeks, and 6 weeks. If you still need the PR, you can reopen or recreate the request.

For more information, see the Content review process summary.

Added examples for updating customers
@dylanstetts dylanstetts added customer support issue Doc issue raised from customer support ready for content review PR is ready for a content review - content development and tech review are complete. labels Apr 10, 2026
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit ce7283b:

✅ Validation status: passed

File Status Preview URL Details
api-reference/v1.0/api/bookingappointment-update.md ✅Succeeded

For more details, please refer to the build report.

Copy link
Copy Markdown
Contributor

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 a validated PATCH example to the Update bookingAppointment API documentation that demonstrates updating the customers array for multi-customer appointments, addressing a documented support gap around required payload shape.

Changes:

  • Renamed the existing sample to Example 1: Change the date of service and added a unique request name.
  • Added Example 2: Update the customers for an appointment, including notes about required @odata.type, full replacement semantics, and multi-attendee service requirements.
Comments suppressed due to low confidence (1)

api-reference/v1.0/api/bookingappointment-update.md:175

  • The response metadata sets "truncated": true, but this example returns 204 No Content with no response body. Remove the truncated flag (or set it to false) to avoid implying a shortened payload where none exists.
<!-- {
  "blockType": "response",
  "truncated": true
} -->

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c82c0ff:

✅ Validation status: passed

File Status Preview URL Details
api-reference/v1.0/api/bookingappointment-update.md ✅Succeeded

For more details, please refer to the build report.

@Danipocket Danipocket merged commit 628ac86 into microsoftgraph:main Apr 13, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

customer support issue Doc issue raised from customer support ready for content review PR is ready for a content review - content development and tech review are complete.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants