Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Users.mailbox Settings API

3 actions 3 updates phrasing extends openapi/azure-ad-users-mailboxsettings-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/users/{user-id}/mailboxSettings'].get

$.paths['/users/{user-id}/mailboxSettings'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Users.mailbox Settings API
  version: 1.0.0
extends: openapi/azure-ad-users-mailboxsettings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/users/{user-id}/mailboxSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's mailbox settings
      effect: read
      questions:
      - What are a user's mailbox settings like time zone and language?
      - Can I check whether automatic replies are on for a user?
      instructions:
      - text: Get mailbox settings for {user}.
        slots:
          user: path.user-id
      - text: Show {user}'s working hours and time zone.
        slots:
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/mailboxSettings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's mailbox settings
      effect: write
      questions:
      - How do I change a user's mailbox time zone?
      - Can I set automatic replies for someone's mailbox?
      instructions:
      - text: Set the mailbox time zone of {user} to {tz}.
        slots:
          user: path.user-id
          tz: requestBody.timeZone
      - text: Update automatic replies for {user} to {auto_reply}.
        slots:
          user: path.user-id
          auto_reply: requestBody.automaticRepliesSetting
      method: generated
      generated: '2026-10-01'