Update

Description

Update an annotation.

Request

HTTP Method: PUT

Parameter Description
content Optional The annotation Markdown formatted content.
position Optional An object describing the XY coordinates of the position on the story diagram.
Path Parameter Description
annotation-id ID 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

Parameter Description
id The annotation ID.
story_id ID of story to which the annotation belongs.
content The annotation Markdown formatted content.
position An 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"
}