Skip to main content
PATCH
/
v1
/
alarms
/
forecasts
/
update
Update registration
curl --request PATCH \
  --url https://api.iklim.co/v1/alarms/forecasts/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "customer-system-001",
  "boundary": {
    "cityId": 6,
    "districtId": 557
  },
  "forecastDays": 3,
  "forecastAlarmDelivery": [
    "MORNING",
    "EVENING"
  ],
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/forecast-callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "type": "API_KEY",
      "username": "alert-user",
      "password": "******"
    },
    "requestHeaders": {
      "source": "iklim.co",
      "custom-header": "value"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "precipitationThreshold": "MODERATE",
    "snowFallThreshold": "LIGHT",
    "windGustThreshold": "STRONG_WIND",
    "hotTemperatureThreshold": "HOT_SNAP",
    "coldTemperatureThreshold": "COLD_SNAP"
  }
}
'
import requests

url = "https://api.iklim.co/v1/alarms/forecasts/update"

payload = {
    "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
    "recipientId": "customer-system-001",
    "boundary": {
        "cityId": 6,
        "districtId": 557
    },
    "forecastDays": 3,
    "forecastAlarmDelivery": ["MORNING", "EVENING"],
    "webhook": {
        "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
        "url": "https://api.customer.com/alerts/forecast-callback",
        "httpMethod": "POST",
        "contentType": "application/json",
        "authentication": {
            "type": "API_KEY",
            "username": "alert-user",
            "password": "******"
        },
        "requestHeaders": {
            "source": "iklim.co",
            "custom-header": "value"
        },
        "deliveryPolicy": {
            "timeout": 60,
            "maxRetries": 3,
            "retryDelay": 10
        }
    },
    "filter": {
        "precipitationThreshold": "MODERATE",
        "snowFallThreshold": "LIGHT",
        "windGustThreshold": "STRONG_WIND",
        "hotTemperatureThreshold": "HOT_SNAP",
        "coldTemperatureThreshold": "COLD_SNAP"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    registrationId: 'f7587d9e-2481-4b4c-818d-c8d1946851b7',
    recipientId: 'customer-system-001',
    boundary: {cityId: 6, districtId: 557},
    forecastDays: 3,
    forecastAlarmDelivery: ['MORNING', 'EVENING'],
    webhook: {
      accountId: '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1',
      url: 'https://api.customer.com/alerts/forecast-callback',
      httpMethod: 'POST',
      contentType: 'application/json',
      authentication: {type: 'API_KEY', username: 'alert-user', password: '******'},
      requestHeaders: {source: 'iklim.co', 'custom-header': 'value'},
      deliveryPolicy: {timeout: 60, maxRetries: 3, retryDelay: 10}
    },
    filter: {
      precipitationThreshold: 'MODERATE',
      snowFallThreshold: 'LIGHT',
      windGustThreshold: 'STRONG_WIND',
      hotTemperatureThreshold: 'HOT_SNAP',
      coldTemperatureThreshold: 'COLD_SNAP'
    }
  })
};

fetch('https://api.iklim.co/v1/alarms/forecasts/update', 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://api.iklim.co/v1/alarms/forecasts/update",
  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([
    'registrationId' => 'f7587d9e-2481-4b4c-818d-c8d1946851b7',
    'recipientId' => 'customer-system-001',
    'boundary' => [
        'cityId' => 6,
        'districtId' => 557
    ],
    'forecastDays' => 3,
    'forecastAlarmDelivery' => [
        'MORNING',
        'EVENING'
    ],
    'webhook' => [
        'accountId' => '2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1',
        'url' => 'https://api.customer.com/alerts/forecast-callback',
        'httpMethod' => 'POST',
        'contentType' => 'application/json',
        'authentication' => [
                'type' => 'API_KEY',
                'username' => 'alert-user',
                'password' => '******'
        ],
        'requestHeaders' => [
                'source' => 'iklim.co',
                'custom-header' => 'value'
        ],
        'deliveryPolicy' => [
                'timeout' => 60,
                'maxRetries' => 3,
                'retryDelay' => 10
        ]
    ],
    'filter' => [
        'precipitationThreshold' => 'MODERATE',
        'snowFallThreshold' => 'LIGHT',
        'windGustThreshold' => 'STRONG_WIND',
        'hotTemperatureThreshold' => 'HOT_SNAP',
        'coldTemperatureThreshold' => 'COLD_SNAP'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.iklim.co/v1/alarms/forecasts/update"

	payload := strings.NewReader("{\n  \"registrationId\": \"f7587d9e-2481-4b4c-818d-c8d1946851b7\",\n  \"recipientId\": \"customer-system-001\",\n  \"boundary\": {\n    \"cityId\": 6,\n    \"districtId\": 557\n  },\n  \"forecastDays\": 3,\n  \"forecastAlarmDelivery\": [\n    \"MORNING\",\n    \"EVENING\"\n  ],\n  \"webhook\": {\n    \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\",\n    \"url\": \"https://api.customer.com/alerts/forecast-callback\",\n    \"httpMethod\": \"POST\",\n    \"contentType\": \"application/json\",\n    \"authentication\": {\n      \"type\": \"API_KEY\",\n      \"username\": \"alert-user\",\n      \"password\": \"******\"\n    },\n    \"requestHeaders\": {\n      \"source\": \"iklim.co\",\n      \"custom-header\": \"value\"\n    },\n    \"deliveryPolicy\": {\n      \"timeout\": 60,\n      \"maxRetries\": 3,\n      \"retryDelay\": 10\n    }\n  },\n  \"filter\": {\n    \"precipitationThreshold\": \"MODERATE\",\n    \"snowFallThreshold\": \"LIGHT\",\n    \"windGustThreshold\": \"STRONG_WIND\",\n    \"hotTemperatureThreshold\": \"HOT_SNAP\",\n    \"coldTemperatureThreshold\": \"COLD_SNAP\"\n  }\n}")

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

	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://api.iklim.co/v1/alarms/forecasts/update")
  .header("Content-Type", "application/json")
  .body("{\n  \"registrationId\": \"f7587d9e-2481-4b4c-818d-c8d1946851b7\",\n  \"recipientId\": \"customer-system-001\",\n  \"boundary\": {\n    \"cityId\": 6,\n    \"districtId\": 557\n  },\n  \"forecastDays\": 3,\n  \"forecastAlarmDelivery\": [\n    \"MORNING\",\n    \"EVENING\"\n  ],\n  \"webhook\": {\n    \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\",\n    \"url\": \"https://api.customer.com/alerts/forecast-callback\",\n    \"httpMethod\": \"POST\",\n    \"contentType\": \"application/json\",\n    \"authentication\": {\n      \"type\": \"API_KEY\",\n      \"username\": \"alert-user\",\n      \"password\": \"******\"\n    },\n    \"requestHeaders\": {\n      \"source\": \"iklim.co\",\n      \"custom-header\": \"value\"\n    },\n    \"deliveryPolicy\": {\n      \"timeout\": 60,\n      \"maxRetries\": 3,\n      \"retryDelay\": 10\n    }\n  },\n  \"filter\": {\n    \"precipitationThreshold\": \"MODERATE\",\n    \"snowFallThreshold\": \"LIGHT\",\n    \"windGustThreshold\": \"STRONG_WIND\",\n    \"hotTemperatureThreshold\": \"HOT_SNAP\",\n    \"coldTemperatureThreshold\": \"COLD_SNAP\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.iklim.co/v1/alarms/forecasts/update")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"registrationId\": \"f7587d9e-2481-4b4c-818d-c8d1946851b7\",\n  \"recipientId\": \"customer-system-001\",\n  \"boundary\": {\n    \"cityId\": 6,\n    \"districtId\": 557\n  },\n  \"forecastDays\": 3,\n  \"forecastAlarmDelivery\": [\n    \"MORNING\",\n    \"EVENING\"\n  ],\n  \"webhook\": {\n    \"accountId\": \"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1\",\n    \"url\": \"https://api.customer.com/alerts/forecast-callback\",\n    \"httpMethod\": \"POST\",\n    \"contentType\": \"application/json\",\n    \"authentication\": {\n      \"type\": \"API_KEY\",\n      \"username\": \"alert-user\",\n      \"password\": \"******\"\n    },\n    \"requestHeaders\": {\n      \"source\": \"iklim.co\",\n      \"custom-header\": \"value\"\n    },\n    \"deliveryPolicy\": {\n      \"timeout\": 60,\n      \"maxRetries\": 3,\n      \"retryDelay\": 10\n    }\n  },\n  \"filter\": {\n    \"precipitationThreshold\": \"MODERATE\",\n    \"snowFallThreshold\": \"LIGHT\",\n    \"windGustThreshold\": \"STRONG_WIND\",\n    \"hotTemperatureThreshold\": \"HOT_SNAP\",\n    \"coldTemperatureThreshold\": \"COLD_SNAP\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
  "recipientId": "customer-system-001",
  "boundary": {
    "cityId": 6,
    "districtId": 557
  },
  "forecastDays": 3,
  "forecastAlarmDelivery": [
    "MORNING",
    "EVENING"
  ],
  "webhook": {
    "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
    "url": "https://api.customer.com/alerts/forecast-callback",
    "httpMethod": "POST",
    "contentType": "application/json",
    "authentication": {
      "username": "alert-user",
      "password": "******"
    },
    "requestHeaders": {
      "source": "iklim.co",
      "custom-header": "value"
    },
    "deliveryPolicy": {
      "timeout": 60,
      "maxRetries": 3,
      "retryDelay": 10
    }
  },
  "filter": {
    "precipitationThreshold": "MODERATE",
    "snowFallThreshold": "LIGHT",
    "windGustThreshold": "STRONG_WIND",
    "hotTemperatureThreshold": "HOT_SNAP",
    "coldTemperatureThreshold": "COLD_SNAP"
  },
  "createdAt": "2025-01-01T10:15:30Z",
  "updatedAt": "2025-01-01T11:15:30Z",
  "warnings": [
    "warning-1",
    "warning-2"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}
{
  "timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
  "status": "XXX",
  "error": "Error Name",
  "message": "Error Message",
  "path": "/endpoint/uri/here",
  "messages": [
    "<string>"
  ]
}

Body

application/json

Forecast point alarm registration.

​
registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

​
boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for forecast alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by a city (cityId) and a district (districtId); both fields are required.
  • POINT – boundary defined by a single longitude/latitude coordinate (point). The alarm evaluates forecast data for the nearest forecast grid cell to that coordinate.
​
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–14).

Example:

3

​
forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
["MORNING", "EVENING"]
​
webhook
object

Outbound callback configuration for this registration.

​
filter
object

Threshold filters that control which forecast conditions trigger an alarm.

Response

OK

​
registrationId
string<uuid>

UUID of the registration record (required for update operations).

Example:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Caller-defined external reference identifier for the notification recipient.

Example:

"customer-system-001"

​
boundary
object

Alarm registration boundary

Defines the geographic scope to monitor for forecast alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by a city (cityId) and a district (districtId); both fields are required.
  • POINT – boundary defined by a single longitude/latitude coordinate (point). The alarm evaluates forecast data for the nearest forecast grid cell to that coordinate.
​
forecastDays
integer<int32>

Number of forecast days ahead to evaluate for alarm conditions (1–14).

Example:

3

​
forecastAlarmDelivery
enum<string>[]

Time windows at which alarm notifications are dispatched (MORNING – 04:00 UTC, EVENING – 16:00 UTC).

Available options:
MORNING,
EVENING
Example:
["MORNING", "EVENING"]
​
webhook
object

Outbound callback configuration for this registration.

​
filter
object

Threshold filters that control which forecast conditions trigger an alarm.

​
createdAt
string<date-time>

Timestamp when the registration was first created (ISO-8601).

Example:

"2025-01-01T10:15:30Z"

​
updatedAt
string<date-time>

Timestamp of the most recent update to the registration (ISO-8601).

Example:

"2025-01-01T11:15:30Z"

​
warnings
string[]

Non-fatal warnings generated during registration processing.

Example:
["warning-1", "warning-2"]