- create_stories
- Create one or more stories in a team's backlog, as the connected user. Each story needs a title and a description. Relations use the slugs and member emails from list_teams. Returns the new story references.
- update_story
- Change a story as the connected user: move it to another status, (re)assign it, estimate it, move it into a sprint or the backlog, or edit its text. Only the fields you pass are changed, and a text field you pass replaces that whole field. To change part of a text field, fetch it with get_story format "html", edit that HTML and send it back with text_format "html", so images, formatting and mentions are kept. Use add_comment for notes and toggle_checklist_item for checklists. Moving a story to a status can auto-assign it, exactly like dragging it on the board.
- add_comment
- Post a comment on a story as the connected user. Mention team members with @ and their email to notify them.
- update_comment
- Rewrite one of the connected user's own comments on a story. get_story lists the comments with their reference and whether they are yours. The new body replaces the old one in full.
- delete_comment
- Delete one of the connected user's own comments on a story. This cannot be undone, so confirm with the user first.
- start_story
- Start working on a story as the connected user: assigns it to them, moves it to the team's in-progress status, and returns the git branch name to use (when the team has a repository configured).
- link_stories
- Link two stories of the same team, e.g. "ABC-12 blocks ABC-15". A blocked story is flagged on the board until its blocker is done. Circular blocks are refused.
- unlink_stories
- Remove every link between two stories, in either direction.
- toggle_checklist_item
- Tick off (or untick) a checklist item in a story. get_story lists each checklist item with its field, index and text; pass them back unchanged so the right item is toggled.
- create_epic
- Create an empty epic. Add stories to it with create_stories or update_story using the returned slug. To create an epic with its stories from a template, use create_epic_from_template instead.
- close_epic
- Close an epic once all of its stories are done or cancelled. Closed epics drop out of the epic lists; reopen_epic brings one back.
- reopen_epic
- Reopen a closed epic so new stories can be added to it again.
- create_epic_from_template
- Create an epic and its stories from one of the team's epic templates, filling in the template's fields. Call list_epic_templates first to see each template's fields and stories. Stories are assigned by role, just like in the app.
- create_sprint
- Plan a new sprint for the team. It starts out as planned; move stories into it with update_story and start it with start_sprint.
- start_sprint
- Start a planned sprint today, making it the team's active sprint on the board. Fails while another sprint is still active; end that one first with end_sprint.
- end_sprint
- End the team's active sprint today. Unfinished stories move to the next planned sprint, which is created when there is none. This cannot be undone, so confirm with the user first.