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

API Evangelist conversational phrasing for Users.outlook User API

11 actions 11 updates phrasing extends openapi/azure-ad-users-outlookuser-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 11

$.info
$.paths['/users/{user-id}/outlook'].get
$.paths['/users/{user-id}/outlook/masterCategories'].get
$.paths['/users/{user-id}/outlook/masterCategories'].post
$.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].get
$.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].delete
$.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].patch
$.paths['/users/{user-id}/outlook/masterCategories/$count'].get
$.paths['/users/{user-id}/outlook/microsoft.graph.supportedLanguages()'].get
$.paths['/users/{user-id}/outlook/microsoft.graph.supportedTimeZones()'].get
$.paths['/users/{user-id}/outlook/microsoft.graph.supportedTimeZones(TimeZoneStandard=\'{TimeZoneStandard}\')'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Users.outlook User API
  version: 1.0.0
extends: openapi/azure-ad-users-outlookuser-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: 10
- target: $.paths['/users/{user-id}/outlook'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's Outlook settings container
      effect: read
      questions:
      - Can I read the Outlook services object for a user in Microsoft Graph?
      - What sits under a user's outlook resource?
      instructions:
      - text: Get the Outlook object for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Show the outlook container of {user_id} with its properties.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's Outlook categories
      effect: read
      questions:
      - Which color categories has a user defined in Outlook?
      - How do I see the master category list a user tags mail and events with?
      instructions:
      - text: List the Outlook master categories for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Show every category name and color defined by {user_id}.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Outlook category for a user
      effect: write
      questions:
      - Can I add a new color category to a user's Outlook master list?
      - Which color can I assign when creating an Outlook category?
      instructions:
      - text: Create Outlook category {name} for user {user_id}.
        slots:
          name: requestBody.displayName
          user_id: path.user-id
      - text: Add category {name} with color {color} to {user_id}'s master list.
        slots:
          name: requestBody.displayName
          color: requestBody.color
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of a user's Outlook categories
      effect: read
      questions:
      - What name and color does a specific Outlook category of a user have?
      - Can I look up a single master category by its id?
      instructions:
      - text: Get Outlook category {category_id} of user {user_id}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
      - text: Show the name and color of category {category_id} for {user_id}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of a user's Outlook categories
      effect: destructive
      questions:
      - Can I remove a category from a user's Outlook master list?
      - Is deleting an Outlook category something I can undo?
      instructions:
      - text: Delete Outlook category {category_id} from user {user_id}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
      - text: Remove category {category_id} from {user_id}'s master list if its ETag is {etag}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories/{outlookCategory-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing Outlook category
      effect: write
      questions:
      - Can I change the color of an Outlook category a user already has?
      - Which properties of an existing master category are editable?
      instructions:
      - text: Change the color of category {category_id} for user {user_id} to {color}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
          color: requestBody.color
      - text: Update existing Outlook category {category_id} of {user_id}.
        slots:
          category_id: path.outlookCategory-id
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/masterCategories/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's Outlook categories
      effect: read
      questions:
      - How many Outlook categories has a user defined?
      - Can I get just the total size of a user's master category list?
      instructions:
      - text: Count the Outlook master categories of user {user_id}.
        slots:
          user_id: path.user-id
      - text: Return only the category total for {user_id}.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/microsoft.graph.supportedLanguages()'].get
  update:
    x-apievangelist-phrasing:
      intent: List languages supported for a user's mailbox
      effect: read
      questions:
      - Which locales and languages does a user's mailbox server support?
      - What language options can I offer a user for their Outlook settings?
      instructions:
      - text: List the supported languages for the mailbox of user {user_id}.
        slots:
          user_id: path.user-id
      - text: Show the locales configured on {user_id}'s mailbox server.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/microsoft.graph.supportedTimeZones()'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's supported time zones in the default format
      effect: read
      questions:
      - What time zones does a user's Outlook mailbox support, without picking a naming standard?
      - Can I page through the default list of time zones available to a user's mailbox?
      instructions:
      - text: List the time zones {user_id}'s mailbox supports, using the default naming.
        slots:
          user_id: path.user-id
      - text: Show the first {top} supported time zones for {user_id}'s Outlook settings.
        slots:
          user_id: path.user-id
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/outlook/microsoft.graph.supportedTimeZones(TimeZoneStandard=\'{TimeZoneStandard}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported time zones in a chosen standard
      effect: read
      questions:
      - Can I get a user's supported time zones in Windows or IANA format?
      - Which time zone naming standard can I request for the mailbox's supported list?
      instructions:
      - text: Return {user_id}'s mailbox-supported time zones named per the {standard} standard, Windows or IANA.
        slots:
          user_id: path.user-id
          standard: path.TimeZoneStandard
      - text: Show {user_id}'s mailbox time zones using naming standard {standard}.
        slots:
          user_id: path.user-id
          standard: path.TimeZoneStandard
      method: generated
      generated: '2026-10-01'