Change users product

PUT

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

Last modified:2025-04-24 10:59:46

Update user notification preferences

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

update preference

Body

🟠401Unauthorized

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v2/user/preferences/notifications/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "when_status": [
        "started"
    ],
    "if_status": [
        "fail",
        "pass"
    ],
    "if_severity": [
        6
    ]
}'

Response Example

200 - Scan event

{
    "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"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Modified at 2025-04-24 10:59:46

Get users notification preferences

Enable user's event notification preference