curl --request PUT \
--url https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"headline": "<string>",
"description": "<string>",
"dateFrom": "2026-09-17T09:45:00",
"dateTo": "2026-09-21T18:00:00",
"approximate": true,
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": [
"<string>"
],
"display": true,
"evidence": [],
"refs": [
{
"value": "<string>"
}
],
"note": "<string>"
}
'import requests
url = "https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}"
payload = {
"headline": "<string>",
"description": "<string>",
"dateFrom": "2026-09-17T09:45:00",
"dateTo": "2026-09-21T18:00:00",
"approximate": True,
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": ["<string>"],
"display": True,
"evidence": [],
"refs": [{ "value": "<string>" }],
"note": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
headline: '<string>',
description: '<string>',
dateFrom: '2026-09-17T09:45:00',
dateTo: '2026-09-21T18:00:00',
approximate: true,
reading: '<string>',
scope: {
applicationID: '<string>',
os: '<string>',
osVersion: '<string>',
browser: '<string>',
customTag1: '<string>',
customTag2: '<string>',
customTag3: '<string>',
customTag4: '<string>',
customTag5: '<string>',
customTag6: '<string>',
customTag7: '<string>',
customTag8: '<string>',
customTag9: '<string>',
customTag10: '<string>',
customTag11: '<string>',
customTag12: '<string>',
customTag13: '<string>',
customTag14: '<string>',
customTag15: '<string>',
customTag16: '<string>',
customTag17: '<string>',
customTag18: '<string>',
customTag19: '<string>',
customTag20: '<string>',
experimentRunID: '<string>',
experimentVariantID: '<string>'
},
series: ['<string>'],
display: true,
evidence: [],
refs: [{value: '<string>'}],
note: '<string>'
})
};
fetch('https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}', 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.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'headline' => '<string>',
'description' => '<string>',
'dateFrom' => '2026-09-17T09:45:00',
'dateTo' => '2026-09-21T18:00:00',
'approximate' => true,
'reading' => '<string>',
'scope' => [
'applicationID' => '<string>',
'os' => '<string>',
'osVersion' => '<string>',
'browser' => '<string>',
'customTag1' => '<string>',
'customTag2' => '<string>',
'customTag3' => '<string>',
'customTag4' => '<string>',
'customTag5' => '<string>',
'customTag6' => '<string>',
'customTag7' => '<string>',
'customTag8' => '<string>',
'customTag9' => '<string>',
'customTag10' => '<string>',
'customTag11' => '<string>',
'customTag12' => '<string>',
'customTag13' => '<string>',
'customTag14' => '<string>',
'customTag15' => '<string>',
'customTag16' => '<string>',
'customTag17' => '<string>',
'customTag18' => '<string>',
'customTag19' => '<string>',
'customTag20' => '<string>',
'experimentRunID' => '<string>',
'experimentVariantID' => '<string>'
],
'series' => [
'<string>'
],
'display' => true,
'evidence' => [
],
'refs' => [
[
'value' => '<string>'
]
],
'note' => '<string>'
]),
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.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}"
payload := strings.NewReader("{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"kind": "event",
"platform": true,
"headline": "<string>",
"approximate": true,
"display": true,
"source": "manual",
"createdMs": 123,
"updatedMs": 123,
"description": "<string>",
"dateFrom": "<string>",
"dateTo": "<string>",
"datePrecision": "month",
"dateFromMs": 123,
"dateToMs": 123,
"status": "open",
"effect": "context",
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": [
"<string>"
],
"evidence": [
"code"
],
"refs": [
{
"type": "finding",
"value": "<string>"
}
],
"externalKey": "<string>"
}{
"error": {
"message": "Validation failed",
"details": [
{
"field": "projectID",
"message": "required"
}
]
}
}Create or update annotation by external key
Creates the project’s annotation with this external key on the first call and replaces its content on
later calls, so a writer that runs repeatedly (a release pipeline, a scheduled agent) keeps one annotation
per key. Replacing follows the rules of PUT /observe/annotations/{annotationID}. The history records
created or the kind of change.
Concurrent first calls with the same key can answer 409; retrying updates the annotation then created.
Required API key permission: observe:annotations:write.
curl --request PUT \
--url https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"headline": "<string>",
"description": "<string>",
"dateFrom": "2026-09-17T09:45:00",
"dateTo": "2026-09-21T18:00:00",
"approximate": true,
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": [
"<string>"
],
"display": true,
"evidence": [],
"refs": [
{
"value": "<string>"
}
],
"note": "<string>"
}
'import requests
url = "https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}"
payload = {
"headline": "<string>",
"description": "<string>",
"dateFrom": "2026-09-17T09:45:00",
"dateTo": "2026-09-21T18:00:00",
"approximate": True,
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": ["<string>"],
"display": True,
"evidence": [],
"refs": [{ "value": "<string>" }],
"note": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
headline: '<string>',
description: '<string>',
dateFrom: '2026-09-17T09:45:00',
dateTo: '2026-09-21T18:00:00',
approximate: true,
reading: '<string>',
scope: {
applicationID: '<string>',
os: '<string>',
osVersion: '<string>',
browser: '<string>',
customTag1: '<string>',
customTag2: '<string>',
customTag3: '<string>',
customTag4: '<string>',
customTag5: '<string>',
customTag6: '<string>',
customTag7: '<string>',
customTag8: '<string>',
customTag9: '<string>',
customTag10: '<string>',
customTag11: '<string>',
customTag12: '<string>',
customTag13: '<string>',
customTag14: '<string>',
customTag15: '<string>',
customTag16: '<string>',
customTag17: '<string>',
customTag18: '<string>',
customTag19: '<string>',
customTag20: '<string>',
experimentRunID: '<string>',
experimentVariantID: '<string>'
},
series: ['<string>'],
display: true,
evidence: [],
refs: [{value: '<string>'}],
note: '<string>'
})
};
fetch('https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}', 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.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'headline' => '<string>',
'description' => '<string>',
'dateFrom' => '2026-09-17T09:45:00',
'dateTo' => '2026-09-21T18:00:00',
'approximate' => true,
'reading' => '<string>',
'scope' => [
'applicationID' => '<string>',
'os' => '<string>',
'osVersion' => '<string>',
'browser' => '<string>',
'customTag1' => '<string>',
'customTag2' => '<string>',
'customTag3' => '<string>',
'customTag4' => '<string>',
'customTag5' => '<string>',
'customTag6' => '<string>',
'customTag7' => '<string>',
'customTag8' => '<string>',
'customTag9' => '<string>',
'customTag10' => '<string>',
'customTag11' => '<string>',
'customTag12' => '<string>',
'customTag13' => '<string>',
'customTag14' => '<string>',
'customTag15' => '<string>',
'customTag16' => '<string>',
'customTag17' => '<string>',
'customTag18' => '<string>',
'customTag19' => '<string>',
'customTag20' => '<string>',
'experimentRunID' => '<string>',
'experimentVariantID' => '<string>'
],
'series' => [
'<string>'
],
'display' => true,
'evidence' => [
],
'refs' => [
[
'value' => '<string>'
]
],
'note' => '<string>'
]),
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.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}"
payload := strings.NewReader("{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.corbado.io/v1/observe/annotations/byExternalKey/{externalKey}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"headline\": \"<string>\",\n \"description\": \"<string>\",\n \"dateFrom\": \"2026-09-17T09:45:00\",\n \"dateTo\": \"2026-09-21T18:00:00\",\n \"approximate\": true,\n \"reading\": \"<string>\",\n \"scope\": {\n \"applicationID\": \"<string>\",\n \"os\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"browser\": \"<string>\",\n \"customTag1\": \"<string>\",\n \"customTag2\": \"<string>\",\n \"customTag3\": \"<string>\",\n \"customTag4\": \"<string>\",\n \"customTag5\": \"<string>\",\n \"customTag6\": \"<string>\",\n \"customTag7\": \"<string>\",\n \"customTag8\": \"<string>\",\n \"customTag9\": \"<string>\",\n \"customTag10\": \"<string>\",\n \"customTag11\": \"<string>\",\n \"customTag12\": \"<string>\",\n \"customTag13\": \"<string>\",\n \"customTag14\": \"<string>\",\n \"customTag15\": \"<string>\",\n \"customTag16\": \"<string>\",\n \"customTag17\": \"<string>\",\n \"customTag18\": \"<string>\",\n \"customTag19\": \"<string>\",\n \"customTag20\": \"<string>\",\n \"experimentRunID\": \"<string>\",\n \"experimentVariantID\": \"<string>\"\n },\n \"series\": [\n \"<string>\"\n ],\n \"display\": true,\n \"evidence\": [],\n \"refs\": [\n {\n \"value\": \"<string>\"\n }\n ],\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"kind": "event",
"platform": true,
"headline": "<string>",
"approximate": true,
"display": true,
"source": "manual",
"createdMs": 123,
"updatedMs": 123,
"description": "<string>",
"dateFrom": "<string>",
"dateTo": "<string>",
"datePrecision": "month",
"dateFromMs": 123,
"dateToMs": 123,
"status": "open",
"effect": "context",
"reading": "<string>",
"scope": {
"applicationID": "<string>",
"os": "<string>",
"osVersion": "<string>",
"browser": "<string>",
"customTag1": "<string>",
"customTag2": "<string>",
"customTag3": "<string>",
"customTag4": "<string>",
"customTag5": "<string>",
"customTag6": "<string>",
"customTag7": "<string>",
"customTag8": "<string>",
"customTag9": "<string>",
"customTag10": "<string>",
"customTag11": "<string>",
"customTag12": "<string>",
"customTag13": "<string>",
"customTag14": "<string>",
"customTag15": "<string>",
"customTag16": "<string>",
"customTag17": "<string>",
"customTag18": "<string>",
"customTag19": "<string>",
"customTag20": "<string>",
"experimentRunID": "<string>",
"experimentVariantID": "<string>"
},
"series": [
"<string>"
],
"evidence": [
"code"
],
"refs": [
{
"type": "finding",
"value": "<string>"
}
],
"externalKey": "<string>"
}{
"error": {
"message": "Validation failed",
"details": [
{
"field": "projectID",
"message": "required"
}
]
}
}Authorizations
Path Parameters
Body
Date in project time: YYYY-MM, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM:SS; the format sets
the precision. Required for events and periods, optional for follow-ups (not before), not allowed otherwise.
^\d{4}-\d{2}(-\d{2}(T\d{2}(:\d{2}:\d{2})?)?)?$"2026-09-17T09:45:00"
Response
Annotation created or updated.
What the annotation records: event something changed, period something held over a span, setup a fact
about how the project works, interpretation how to read the data, constraint which data may be used,
follow-up an unknown or open work.
event, period, setup, interpretation, constraint, follow-up Was this page helpful?