Create

Description

Use a HTTP POST request to create an notes. Notes were previously called annotations and all the APIs below will continue to support that nomenclature - simply replace note with annotation in the documentation below.

Request

HTTP Method: POST

Parameter Description
story_id ID of story to which the note should be added.
content The note Markdown formatted content.
position Optional An object describing the XY coordinates of the position on the story diagram.

Sample request

curl -X POST \
  https://<tenant-domain>/api/v1/notes/ \
  -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 note.

Field description

Parameter Description
id The note ID.
story_id ID of story to which the note belongs.
content The note 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": 0,
    "y": 0
  },
  "content": "# Header\n This is a list \n - item 1"
}
Was this helpful?