Edit an offset or system notification
curl --request POST \
--url https://api.metronome.com/v2/notifications/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"policy": {
"type": "contract.start",
"offset": "P2D"
}
}
'import requests
url = "https://api.metronome.com/v2/notifications/edit"
payload = {
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"policy": {
"type": "contract.start",
"offset": "P2D"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
policy: {type: 'contract.start', offset: 'P2D'}
})
};
fetch('https://api.metronome.com/v2/notifications/edit', 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.metronome.com/v2/notifications/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
'policy' => [
'type' => 'contract.start',
'offset' => 'P2D'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.metronome.com/v2/notifications/edit"
payload := strings.NewReader("{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.metronome.com/v2/notifications/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.metronome.com/v2/notifications/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"name": "+1 day after contract starts",
"type": "OFFSET_LIFECYCLE_EVENT",
"policy": {
"type": "contract.start",
"offset": "P2D"
},
"environment_type": "PRODUCTION",
"created_at": "2024-01-15T10:30:00Z",
"created_by": "Martins Seyi",
"archived_at": null
}
}{
"code": "NotificationConfigNotFound",
"message": "<string>"
}Notifications
Edit an offset or system notification
Edit an existing offset notification, or enable/disable a system notification
POST
/
v2
/
notifications
/
edit
Edit an offset or system notification
curl --request POST \
--url https://api.metronome.com/v2/notifications/edit \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"policy": {
"type": "contract.start",
"offset": "P2D"
}
}
'import requests
url = "https://api.metronome.com/v2/notifications/edit"
payload = {
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"policy": {
"type": "contract.start",
"offset": "P2D"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
policy: {type: 'contract.start', offset: 'P2D'}
})
};
fetch('https://api.metronome.com/v2/notifications/edit', 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.metronome.com/v2/notifications/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
'policy' => [
'type' => 'contract.start',
'offset' => 'P2D'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.metronome.com/v2/notifications/edit"
payload := strings.NewReader("{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.metronome.com/v2/notifications/edit")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.metronome.com/v2/notifications/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc\",\n \"policy\": {\n \"type\": \"contract.start\",\n \"offset\": \"P2D\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
"name": "+1 day after contract starts",
"type": "OFFSET_LIFECYCLE_EVENT",
"policy": {
"type": "contract.start",
"offset": "P2D"
},
"environment_type": "PRODUCTION",
"created_at": "2024-01-15T10:30:00Z",
"created_by": "Martins Seyi",
"archived_at": null
}
}{
"code": "NotificationConfigNotFound",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Offset or system notification updates
Updated policy configuration. The policy.type must match the existing lifecycle event type.
- Option 1
- Option 2
Show child attributes
Show child attributes
The ID of the notification configuration to edit. Not provided when updating the configuration for system events
Set to true to enable webhook messages for the notification indicated in the policy, false to disable. Only supported by system lifecycle events.
Response
Success
- Option 1
- Option 2
Show child attributes
Show child attributes