Stories > Notes

Create a note

Create a note on the storyboard. Story or Group ID must be provided. Defaults to a draft called test if change control is enabled on the story and no draft_id is provided.

post/api/v1/annotations

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/annotations
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Request body

story_idinteger

ID of the story to which the note should be added

group_idinteger

ID of the group to which the note should be added

contentstring

The Markdown-formatted content of the note

draft_idinteger

ID of the draft to which the note should be added

Response

Successful response

idinteger

Note ID

story_idinteger

ID of the story to which the note belongs

story_modestring

Mode of the story to which the note belongs (LIVE or TEST)

group_idinteger nullable

ID of the group to which the note belongs

contentstring

Markdown-formatted content of the note

positionobject

XY coordinates of the note on the story diagram

draft_idinteger nullable

ID of the draft to which the note belongs

draft_namestring nullable

Name of the draft to which the note belongs

Changes

No recorded changes to this operation across all 1 revision of this API.