Request type reference¶
| Request type | Used by | Important fields and constraints |
|---|---|---|
CreateProjectRequest |
Organizations.CreateProjectAsync |
required Name max 180, required Key max 12, optional nullable Description max 5000 |
UpdateProjectRequest |
Projects.UpdateAsync |
name, nullable description, archived |
CreateBoardRequest |
Projects.CreateBoardAsync |
required name max 120, nullable color max 32, nullable WIP >=1, done flag |
UpdateBoardRequest |
Boards.UpdateAsync |
name/color/WIP/done/hidden |
DeleteBoardRequest |
Boards.DeleteAsync |
optional MoveToBoardId |
ReorderBoardsRequest |
Projects.ReorderBoardsAsync |
required ordered board ID list |
ListTicketsOptions |
Projects.ListTicketsAsync |
board, query, page size 1–200 |
CreateTicketRequest |
Projects.CreateTicketAsync |
title max 500; board ID/slug; nullable HTML max 200k; priority; nullable due date; assignees/labels |
UpdateTicketRequest |
Tickets.UpdateAsync |
patchable ticket fields plus archive flag |
ReorderTicketsRequest |
Projects.ReorderTicketsAsync |
required board ID and ticket ID order |
MoveTicketRequest |
Tickets.MoveAsync |
required board ID; optional position >=0 |
CreateTicketCommentRequest |
Tickets.CreateCommentAsync |
required HTML max 200k |
ListDocumentsOptions |
Organizations.ListDocumentsAsync |
project/status/query/tags/page size 1–200 |
CreateDocumentRequest |
Organizations.CreateDocumentAsync |
title max 500; project/caption/content/status/editors/tags |
UpdateDocumentRequest |
Documents.UpdateAsync |
document patch fields plus archive flag |
CreateDocumentCommentRequest |
Documents.CreateCommentAsync |
required HTML max 200k |
SendNotificationRequest |
Organizations.SendNotificationsAsync |
1–100 user IDs, title max 180, body max 2000, internal /app URL |
Wire conversion¶
Public request properties follow C# naming conventions while ToPayload() emits the snake_case keys defined by OpenAPI. Enum values serialize as lowercase strings. Date-time values serialize in ISO 8601 form through System.Text.Json.
Nullable create/PATCH properties use setter tracking where omission and explicit null have different API meaning. See Partial updates.