Skip to main content

Create

Description#

Use a HTTP POST request to create an annotation.

Request#

HTTP Method: POST

ParameterDescription
story_idID of story to which the annotation should be added.
contentThe annotation Markdown formatted content.
positionOptional An object describing the XY coordinates of the position on the story diagram.

Sample request#

curl -X POST \  https://<tenant-domain>/api/v1/annotations/ \  -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"      }'

Response#

A successful request will return a JSON object describing the created 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": 0,    "y": 0  },  "content": "# Header\n This is a list \n - item 1"}