Update an Annotation Header
Update an existing annotation header, change it's value/name or enable/disable it. Take caution when renaming annotation headers as it will impact all of the annotations that use the header, we recommend not drastically changing the header to a different name/meaning altogether, instead use the add an annotation header request to make a new annotation header.
To get a list of your existing annotation headers, use the get annotation headers request.
Endpoint
Method: PUT
URL: /annotation/header
Request Parameter
Parameter Name | Data Type | Description | Required/Optional |
|---|---|---|---|
| Integer | The ID of the annotation header that you would like to update - this ensures that you update the correct annotation header. If an | Required |
| String | The name of the annotation header once it's updated, this is what will be used as part of the actual annotations. | Required |
| Boolean | Enable ( | Required |
See Sample Request for an example
Response and Error Code
Response Code | Condition |
|---|---|
200 | OK |
Response Parameter
Parameter Name | Data Type | Description |
|---|---|---|
| Integer | The ID of the annotation header that you have updated, if you entered an invalid ID then a new annotation header has been created, with the ID shown here and not the ID in your request. |
| String | The new name of the annotation header, this is what will be used as part of the actual annotations. |
| Boolean | If the header is Enabled ( |
See Sample Response for an example.
Sample Request
{
"id": "2563",
"header": "Example Header1",
"enabled": false
}Sample Response
{
"id": "2563",
"header": "Ben Test2"
}