Update

Description

Update a note. 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: PUT

Parameter Description
content Optional The note Markdown formatted content.
position Optional An object describing the XY coordinates of the position on the story diagram.
Path Parameter Description
note_id ID of the note

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v1/notes/<<note_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <<CREDENTIAL.tines_api_key>>'
  -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 note.

Field description

Parameter Description
id The note ID.
story_id ID of story to which the note belongs.
story_mode Mode of the story to which the note belongs LIVE or TEST
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,
  "story_mode": "LIVE",
  "position": {
    "x": 15,
    "y": 15
  },
  "content": "# Header\n This is a list \n - item 1\n - item 2"
}
Was this helpful?