Update an annotation
curl --request POST \
--url https://{notifuseDomain}/api/annotations.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"title": "Pricing page redesign",
"timezone": "Asia/Tokyo",
"description": "<string>",
"color": "#3b82f6"
}
'import requests
url = "https://{notifuseDomain}/api/annotations.update"
payload = {
"workspace_id": "ws_1234567890",
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"title": "Pricing page redesign",
"timezone": "Asia/Tokyo",
"description": "<string>",
"color": "#3b82f6"
}
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({
workspace_id: 'ws_1234567890',
id: '3f2504e04f8911d39a0c0305e82c3301',
annotated_at: '2026-08-15T09:00:00Z',
title: 'Pricing page redesign',
timezone: 'Asia/Tokyo',
description: '<string>',
color: '#3b82f6'
})
};
fetch('https://{notifuseDomain}/api/annotations.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://{notifuseDomain}/api/annotations.update",
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([
'workspace_id' => 'ws_1234567890',
'id' => '3f2504e04f8911d39a0c0305e82c3301',
'annotated_at' => '2026-08-15T09:00:00Z',
'title' => 'Pricing page redesign',
'timezone' => 'Asia/Tokyo',
'description' => '<string>',
'color' => '#3b82f6'
]),
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://{notifuseDomain}/api/annotations.update"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\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://{notifuseDomain}/api/annotations.update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/annotations.update")
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 \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\n}"
response = http.request(request)
puts response.read_body{
"annotation": {
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"timezone": "Asia/Tokyo",
"title": "Pricing page redesign",
"color": "#3b82f6",
"source": "manual",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Rolled out to all visitors after the A/B test.",
"source_id": "bcast_1234567890"
}
}Web Analytics
Update an annotation
Edits an annotation’s moment, timezone and presentation. Requires the web_analytics write permission.
Automatic annotations are editable — an operator may want to reword a broadcast’s title — but their origin is not: source and source_id are reloaded from storage and carried forward, so an edit can neither promote a manual row to a system one nor take over another broadcast’s slot.
POST
/
api
/
annotations.update
Update an annotation
curl --request POST \
--url https://{notifuseDomain}/api/annotations.update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace_id": "ws_1234567890",
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"title": "Pricing page redesign",
"timezone": "Asia/Tokyo",
"description": "<string>",
"color": "#3b82f6"
}
'import requests
url = "https://{notifuseDomain}/api/annotations.update"
payload = {
"workspace_id": "ws_1234567890",
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"title": "Pricing page redesign",
"timezone": "Asia/Tokyo",
"description": "<string>",
"color": "#3b82f6"
}
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({
workspace_id: 'ws_1234567890',
id: '3f2504e04f8911d39a0c0305e82c3301',
annotated_at: '2026-08-15T09:00:00Z',
title: 'Pricing page redesign',
timezone: 'Asia/Tokyo',
description: '<string>',
color: '#3b82f6'
})
};
fetch('https://{notifuseDomain}/api/annotations.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://{notifuseDomain}/api/annotations.update",
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([
'workspace_id' => 'ws_1234567890',
'id' => '3f2504e04f8911d39a0c0305e82c3301',
'annotated_at' => '2026-08-15T09:00:00Z',
'title' => 'Pricing page redesign',
'timezone' => 'Asia/Tokyo',
'description' => '<string>',
'color' => '#3b82f6'
]),
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://{notifuseDomain}/api/annotations.update"
payload := strings.NewReader("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\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://{notifuseDomain}/api/annotations.update")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{notifuseDomain}/api/annotations.update")
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 \"workspace_id\": \"ws_1234567890\",\n \"id\": \"3f2504e04f8911d39a0c0305e82c3301\",\n \"annotated_at\": \"2026-08-15T09:00:00Z\",\n \"title\": \"Pricing page redesign\",\n \"timezone\": \"Asia/Tokyo\",\n \"description\": \"<string>\",\n \"color\": \"#3b82f6\"\n}"
response = http.request(request)
puts response.read_body{
"annotation": {
"id": "3f2504e04f8911d39a0c0305e82c3301",
"annotated_at": "2026-08-15T09:00:00Z",
"timezone": "Asia/Tokyo",
"title": "Pricing page redesign",
"color": "#3b82f6",
"source": "manual",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "Rolled out to all visitors after the A/B test.",
"source_id": "bcast_1234567890"
}
}Authorizations
API token for authentication
Body
application/json
Example:
"ws_1234567890"
Example:
"3f2504e04f8911d39a0c0305e82c3301"
Example:
"2026-08-15T09:00:00Z"
Maximum string length:
100Example:
"Pricing page redesign"
Falls back to the annotation's stored timezone when omitted.
Example:
"Asia/Tokyo"
Maximum string length:
500Falls back to the annotation's stored colour when omitted.
Pattern:
^#[0-9A-Fa-f]{6}$Example:
"#3b82f6"
Response
Annotation updated
Show child attributes
Show child attributes
⌘I
