SuppressionResponse

Endpoints · All schemas

Field	Required	Description
personIds	Yes	Person IDs to suppress from locked browsing sessions
petIds	Yes	Pet IDs to suppress from locked browsing sessions
scope	Yes	Whether suppression applies only to owned assets or all visible assets
tagIds	Yes	Tag IDs to suppress from locked browsing sessions

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: SuppressionScope

{
  "properties": {
    "personIds": {
      "description": "Person IDs to suppress from locked browsing sessions",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "petIds": {
      "description": "Pet IDs to suppress from locked browsing sessions",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "scope": {
      "$ref": "#/components/schemas/SuppressionScope",
      "description": "Whether suppression applies only to owned assets or all visible assets"
    },
    "tagIds": {
      "description": "Tag IDs to suppress from locked browsing sessions",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "personIds",
    "petIds",
    "scope",
    "tagIds"
  ],
  "type": "object"
}