Skip to main content

Update

Description

Update an annotation.

Request

HTTP Method: PUT

ParameterDescription
contentOptional The annotation Markdown formatted content.
positionOptional An object describing the XY coordinates of the position on the story diagram.
Path ParameterDescription
annotation-idID of the annotation

Sample request

curl -X PUT \
https://<tenant-domain>/api/v1/annotations/<annotation-id> \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'
-d '{
"story_id": 813,
"content": "# Header\n This is a list \n - item 1\n - item 2",
"position": {
"x": 10,
"y": 10
}
}'

Response

A successful request will return a JSON object describing the updated annotation

Field description

ParameterDescription
idThe annotation ID.
story_idID of story to which the annotation belongs.
contentThe annotation Markdown formatted content.
positionAn object describing the XY coordinates of the position on the story diagram.

Sample response

{
"id": 21405,
"story_id": 813,
"position": {
"x": 15,
"y": 15
},
"content": "# Header\n This is a list \n - item 1\n - item 2"
}