Change users product

PUT/v2/user/preferences/notifications/{name}

Last modified: 3 days ago

Update user notification preferences

Request

Path Params

name

enum<string>

required

The name of the notification preference

Allowed values:

scan_eventreport_eventexception_eventoverdue_pci_reminder

object {0}

{
  "when_status": [
    "started"
  ],
  "if_status": [
    "fail",
    "pass"
  ],
  "if_severity": [
    6
  ]
}

Request samples

Responses

OK(200)

Unauthorized(401)

Parameter Error(422)

HTTP Code: 200

Content Type : JSONapplication/json

update preference

object {0}

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "uuid"
              },
              "type": {
                "type": "string",
                "value": "notification_preferences"
              },
              "attributes": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "notification_type": {
                    "type": "string",
                    "value": "scan_event"
                  },
                  "enabled": {
                    "type": "boolean",
                    "example": true
                  },
                  "code": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "nullable": true
                  },
                  "params": {
                    "type": "object",
                    "properties": {
                      "when_status": {
                        "type": "array",
                        "description": "Accepted values: completed, started, stopped, failed",
                        "items": {
                          "type": "string"
                        },
                        "example": "completed"
                      },
                      "if_completed": {
                        "type": "array",
                        "description": "Accepted values: pass, fail",
                        "items": {
                          "type": "string"
                        },
                        "example": [
                          "pass"
                        ]
                      },
                      "if_severity": {
                        "type": "array",
                        "items": {
                          "type": "integer"
                        },
                        "example": [
                          6
                        ]
                      }
                    }
                  },
                  "created_at": {
                    "type": "string",
                    "example": "2024-03-04T13:04:41.814Z"
                  },
                  "updated_at": {
                    "type": "string",
                    "example": "2024-03-04T13:04:41.814Z"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Last modified: 3 days ago