UpdateAnnouncementsPreferencesDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-update-announcements-preferences-details-schema.json",
  "title": "UpdateAnnouncementsPreferencesDetails",
  "description": "The object used to update announcement email preferences.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcementspreferences-api-openapi.yml#/components/schemas/UpdateAnnouncementsPreferencesDetails",
  "allOf": [
    {
      "$ref": "#/$defs/BaseCreateAnnouncementsPreferencesDetails"
    },
    {}
  ],
  "x-example": "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"preferenceType\": \"OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS\",\n  \"preferredTimeZone\": \"UTC\",\n  \"type\": \"UpdateAnnouncementsPreferencesDetails\"\n}\n",
  "$defs": {
    "BaseCreateAnnouncementsPreferencesDetails": {
      "description": "The model for the parameters of announcement email preferences configured for the tenancy (root compartment).",
      "properties": {
        "compartmentId": {
          "description": "The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the\nroot compartment OCID.)\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "isUnsubscribed": {
          "description": "A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.\n(Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)\n",
          "type": "boolean"
        },
        "preferenceType": {
          "description": "The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.",
          "enum": [
            "OPT_IN_TENANT_ANNOUNCEMENTS",
            "OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS",
            "OPT_OUT_ALL_ANNOUNCEMENTS"
          ],
          "type": "string"
        },
        "preferredTimeZone": {
          "default": "UTC",
          "description": "The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles",
          "format": "x-obmcs-time-zone",
          "type": "string"
        },
        "type": {
          "description": "The entity type, which specifies a model that either creates new announcement email preferences or updates existing preferences.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "type",
        "preferenceType"
      ],
      "x-example": "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"isUnsubscribed\": true,\n  \"preferenceType\": \"OPT_IN_TENANT_ANNOUNCEMENTS\",\n  \"preferredTimeZone\": \"UTC\",\n  \"type\": \"BaseCreateAnnouncementsPreferencesDetails\"\n}\n"
    }
  }
}