UserSetting

Choose the matching operation

GENERAL and TAGS can be updated with their operation-specific masks. WEBHOOKS is projected for reading; mutate webhooks through their dedicated operations. Token and session internals are not settings available through this schema.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• GETGet User Setting/api/v1/users/{user}/settings/{setting}
• PATCHUpdate User Setting/api/v1/users/{user}/settings/{setting}

Referenced by these component schemas:

• ListUserSettingsResponse

Shape and fields

object

User settings message

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the user setting.\n Format: users/{user}/settings/{setting}, {setting} is the key for the setting.\n For example, \"users/steven/settings/GENERAL\" for general settings."
    },
    "generalSetting": {
      "$ref": "#/components/schemas/UserSetting_GeneralSetting"
    },
    "webhooksSetting": {
      "$ref": "#/components/schemas/UserSetting_WebhooksSetting"
    },
    "tagsSetting": {
      "$ref": "#/components/schemas/UserSetting_TagsSetting"
    }
  },
  "description": "User settings message"
}