Sign in

Changed on
put/api/v1beta/me/profile/preferences

Request

  • The document declares no server URL.
  • Auth: bearer_auth (a scheme the document does not define)

Request body

client_tool_decisionsobject

Replaces all per-tool client tool decisions, keyed by qualified namespace/name.

client_tool_file_approval'never_allow' | 'ask' | 'always_allow'

Default handling of files retrieved by client tools before they leave the device.

preference_assistant_additional_informationstring nullable

Additional contextual information about the user for the assistant.

preference_assistant_custom_instructionsstring nullable

Additional behaviour/style/tone preferences for the assistant.

preference_default_chat_providerstring nullable

Preferred default chat provider/model ID for new chats.

preference_job_titlestring nullable

User's job title.

preference_nicknamestring nullable

Preferred name to address the user with.

preference_starting_assistant_clearedboolean

Set true to explicitly clear the start screen (welcome screen even though an audience pin exists), false to inherit again. Clearing also removes any own pick; picking also un-clears.

preference_starting_assistant_idstring nullable

The user's own start-screen pick when it is an assistant that was never published to the hub, as an assistants.id. Setting either pick field removes the other.

preference_starting_hub_assistant_idstring nullable

The user's own start-screen pick when it is a hub assistant, as an assistant_hub_assistants.id (NOT the clone's assistants.id — those go stale on every hub republish). Explicit null removes the pick and returns to inheriting any audience pin.

Response

client_tool_decisionsobject

Per-tool decisions keyed by qualified namespace/name; absent tools keep their default.

client_tool_file_approval'never_allow' | 'ask' | 'always_allow'

Default handling of files retrieved by client tools before they leave the device.

emailstring

The user's email address. Shouldn't be used as a unique identifier, as it may change.

groupsstring[] required

List of groups the user belongs to.

Derived from the ID token's groups claim, or Microsoft Graph for Entra overage.

idstring required
namestring

The user's display name.

organization_group_idsstring[] required

Organization membership IDs from the token or Entra overage resolution.

These can be used as subject_id when creating share grants with subject_id_type "organization_group_id".

organization_user_idstring

Organization user ID from the oid claim (Entra ID specific).

This can be used as the subject_id when creating share grants with subject_id_type "organization_user_id".

picturestring

The user's profile picture URL.

preference_assistant_additional_informationstring

Additional contextual information about the user for the assistant.

preference_assistant_custom_instructionsstring

Additional behaviour/style/tone preferences for the assistant.

preference_default_chat_providerstring

The user's preferred default chat provider/model ID.

preference_job_titlestring

User's job title.

preference_nicknamestring

Preferred name to address the user with.

preference_starting_assistant_clearedboolean

True when the user explicitly cleared their start screen. This is deliberately distinct from "never set": a clear must keep suppressing an admin's audience pin, while "never set" inherits it.

preference_starting_assistant_idstring

The user's own start-screen pick when it is an assistant that was never published to the hub, stored as an assistants.id. At most one of the two pick fields is ever set.

preference_starting_hub_assistant_idstring

The user's own start-screen pick when it is a hub assistant, stored as an assistant_hub_assistants.id — stable across hub republishes, unlike the clone's assistants.id. The LIVE assistant id it points at is resolved per request by GET /me/starting-assistant.

preferred_languagestring required

The user's preferred language.

The final determined language is intersected with our supported languages, to determine the final language.

Will be a BCP 47 language tag (e.g. "en" or "en-US").

This is derived in the following order (highest priority first):

  • i18n.language.language_detection_priority
  • Default language from i18n.language.default_language
  • "en"

Changes

  • b27d3fe30144Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • ad2c7c9dc9d1Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status