AnnouncementsPreferences

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-announcements-preferences-schema.json",
  "title": "AnnouncementsPreferences",
  "description": "The object for 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/AnnouncementsPreferences",
  "allOf": [
    {
      "$ref": "#/$defs/BaseAnnouncementsPreferences"
    },
    {}
  ],
  "x-example": "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleawuu4tcvbsd2ups5fsclgm5ksfjwmx6faux5sbjyw5ob5ojq2vkxa\",\n  \"id\": \"ocid1.tenancy.oc1..exampleawuu4tcvbsd2ups5fsclgm5ksfjwmx6faux5sbjyw5ob5ojq2vkxa\",\n  \"isUnsubscribed\": true,\n  \"preferenceType\": \"OPT_IN_TENANT_ANNOUNCEMENTS\",\n  \"preferredTimeZone\": \"UTC\",\n  \"timeCreated\": \"2022-01-19T21:30:13.803Z\",\n  \"timeUpdated\": \"2023-05-12T23:41:45.968Z\",\n  \"type\": \"AnnouncementsPreferences\"\n}\n",
  "$defs": {
    "BaseAnnouncementsPreferences": {
      "description": "The object that contains the announcement email preferences configured for the tenancy (root compartment).",
      "properties": {
        "compartmentId": {
          "description": "The OCID of the compartment for which the email preferences apply. Because announcements are\nspecific to a tenancy, specify the tenancy by providing the root compartment OCID.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "id": {
          "description": "The ID of the preferences.",
          "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 regarding receiving announcements by email.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/BaseCreateAnnouncementsPreferencesDetails/preferenceType"
        },
        "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"
        },
        "timeCreated": {
          "description": "When the preferences were set initially.",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "When the preferences were last updated.",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "The entity type, which specifies either an object or a summary object for announcement email preferences.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "x-example": "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleawuu4tcvbsd2ups5fsclgm5ksfjwmx6faux5sbjyw5ob5ojq2vkxa\",\n  \"id\": \"ocid1.tenancy.oc1..exampleawuu4tcvbsd2ups5fsclgm5ksfjwmx6faux5sbjyw5ob5ojq2vkxa\",\n  \"isUnsubscribed\": true,\n  \"preferenceType\": \"OPT_IN_TENANT_ANNOUNCEMENTS\",\n  \"preferredTimeZone\": \"UTC\",\n  \"timeCreated\": \"2022-01-19T21:30:13.803Z\",\n  \"timeUpdated\": \"2023-05-12T23:41:45.968Z\",\n  \"type\": \"AnnouncementsPreferences\"\n}\n"
    }
  }
}