Skip to main content
PATCH
/
notifications
/
preferences
/
{type_code}
Update Notification Preference
curl --request PATCH \
  --url https://www.corgea.app/api/v1/notifications/preferences/{type_code} \
  --header 'CORGEA-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_enabled": true
}
'
import requests

url = "https://www.corgea.app/api/v1/notifications/preferences/{type_code}"

payload = { "email_enabled": True }
headers = {
    "CORGEA-TOKEN": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'CORGEA-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email_enabled: true})
};

fetch('https://www.corgea.app/api/v1/notifications/preferences/{type_code}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.corgea.app/api/v1/notifications/preferences/{type_code}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'email_enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "CORGEA-TOKEN: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.corgea.app/api/v1/notifications/preferences/{type_code}"

	payload := strings.NewReader("{\n  \"email_enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("CORGEA-TOKEN", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://www.corgea.app/api/v1/notifications/preferences/{type_code}")
  .header("CORGEA-TOKEN", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_enabled\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://www.corgea.app/api/v1/notifications/preferences/{type_code}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["CORGEA-TOKEN"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_enabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "status": "ok"
}
{
  "error": "Invalid JSON body"
}
{
  "error": "Missing or invalid authorization header"
}
{
  "error": "Unknown notification type"
}

Authorizations

CORGEA-TOKEN
string
header
required

API key for authentication

Path Parameters

type_code
string
required

Notification type code, such as scheduled_scan.daily_report

Body

application/json
email_enabled
boolean | null
required

Set true or false, or null to inherit the company default

Response

Request completed successfully

status
string
Example:

"ok"