Skip to content

Request classes

Class Endpoint purpose Important behavior
CreateProjectRequest create project required name/key; optional nullable description
UpdateProjectRequest patch project field-presence tracking
CreateBoardRequest create board optional nullable color/WIP limit
UpdateBoardRequest patch board field-presence tracking
ReorderBoardsRequest reorder boards ordered board ID list
DeleteBoardRequest delete board optional move_to_board_id
ListTicketsOptions ticket filters board, search, page size
CreateTicketRequest create ticket board ID or slug, title, HTML, priority, due date, assignees, labels
UpdateTicketRequest patch ticket explicit null support; archive state
ReorderTicketsRequest reorder tickets board ID and ordered ticket IDs
MoveTicketRequest move ticket destination board; optional position
CreateCommentRequest ticket/document comment HTML body up to 200,000 characters
ListDocumentsOptions document filters project, status, search, tags, page size
CreateDocumentRequest create document project/title/caption/content/status/editors/tags
UpdateDocumentRequest patch document explicit null and archive/publication handling
SendNotificationRequest organization notification 1–100 users and optional internal /app URL

Every request object exposes its exact wire field map through toMap(). Application code normally does not need to call toMap() directly; service methods call it after validation.