Update notification configuration - Lerian

Update notification configuration

curl --request PUT \
  --url https://api.example.com/api/v1/siloc/notifications/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "channels": [
    "<string>"
  ],
  "expectedVersion": 2,
  "windowLeadMinutes": 60
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/notifications/config"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"expectedVersion\": 2,\n  \"windowLeadMinutes\": 60\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'PUT',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({channels: ['<string>'], expectedVersion: 2, windowLeadMinutes: 60})
};

fetch('https://api.example.com/api/v1/siloc/notifications/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/notifications/config"

payload = {
    "channels": ["<string>"],
    "expectedVersion": 2,
    "windowLeadMinutes": 60
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "channels": [
    "<string>"
  ],
  "version": 123,
  "windowLeadMinutes": 123
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

PUT

/

api

/

v1

/

siloc

/

notifications

/

config

Update notification configuration

curl --request PUT \
  --url https://api.example.com/api/v1/siloc/notifications/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "channels": [
    "<string>"
  ],
  "expectedVersion": 2,
  "windowLeadMinutes": 60
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/notifications/config"

	payload := strings.NewReader("{\n  \"channels\": [\n    \"<string>\"\n  ],\n  \"expectedVersion\": 2,\n  \"windowLeadMinutes\": 60\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'PUT',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({channels: ['<string>'], expectedVersion: 2, windowLeadMinutes: 60})
};

fetch('https://api.example.com/api/v1/siloc/notifications/config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/notifications/config"

payload = {
    "channels": ["<string>"],
    "expectedVersion": 2,
    "windowLeadMinutes": 60
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "channels": [
    "<string>"
  ],
  "version": 123,
  "windowLeadMinutes": 123
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Cuerpo

application/json

channels

string[] | null

requerido

Channels to store; non-empty, unique, subset of {WEBHOOK, EMAIL}.

Maximum array length: 20

expectedVersion

integer<int64>

requerido

The version last read; the update applies only while it still matches (optimistic lock).

Rango requerido: x >= 1

windowLeadMinutes

integer<int64>

requerido

Lead time (minutes), 1-120.

Rango requerido: 1 <= x <= 120

Respuesta

OK

channels

string[]

requerido

Notification channels stored with this configuration (WEBHOOK, EMAIL).

version

integer<int64>

requerido

Optimistic-concurrency version; pass as expectedVersion on the next update.

windowLeadMinutes

integer<int64>

requerido

Lead time (minutes) before a deposit-window close at which to fire the alert.