Visual project management and collaboration
developer.atlassian.com/cloud/trello/rest ↗Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://trello.com/1
/actions/{idAction}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actions"
}
}
},
"required": true,
"description": "Attributes of \"Actions\" to be updated."
}
PUT /actions/{idAction}
/actions/{idAction}/text
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idAction | path | required | string | idAction |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/actions_text"
}
}
},
"required": true,
"description": "Attributes of \"Actions Text\" to be updated."
}
PUT /actions/{idAction}/text
/boards/{idBoard}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards"
}
}
},
"required": true,
"description": "Attributes of \"Boards\" to be updated."
}
PUT /boards/{idBoard}
/boards/{idBoard}/closed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_closed"
}
}
},
"required": true,
"description": "Attributes of \"Boards Closed\" to be updated."
}
PUT /boards/{idBoard}/closed
/boards/{idBoard}/desc
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_desc"
}
}
},
"required": true,
"description": "Attributes of \"Boards Desc\" to be updated."
}
PUT /boards/{idBoard}/desc
/boards/{idBoard}/idOrganization
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_idOrganization"
}
}
},
"required": true,
"description": "Attributes of \"Boards Id Organization\" to be updated."
}
PUT /boards/{idBoard}/idOrganization
/boards/{idBoard}/labelNames/blue
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_blue"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Blue\" to be updated."
}
PUT /boards/{idBoard}/labelNames/blue
/boards/{idBoard}/labelNames/green
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_green"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Green\" to be updated."
}
PUT /boards/{idBoard}/labelNames/green
/boards/{idBoard}/labelNames/orange
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_orange"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Orange\" to be updated."
}
PUT /boards/{idBoard}/labelNames/orange
/boards/{idBoard}/labelNames/purple
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_purple"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Purple\" to be updated."
}
PUT /boards/{idBoard}/labelNames/purple
/boards/{idBoard}/labelNames/red
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_red"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Red\" to be updated."
}
PUT /boards/{idBoard}/labelNames/red
/boards/{idBoard}/labelNames/yellow
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labelNames_yellow"
}
}
},
"required": true,
"description": "Attributes of \"Label Names Yellow\" to be updated."
}
PUT /boards/{idBoard}/labelNames/yellow
/boards/{idBoard}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"$ref": "#/components/requestBodies/boards_members"
}
PUT /boards/{idBoard}/members
/boards/{idBoard}/members/{idMember}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idMember | path | required | string | idMember |
{
"$ref": "#/components/requestBodies/boards_members"
}
PUT /boards/{idBoard}/members/{idMember}
/boards/{idBoard}/memberships/{idMembership}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
| idMembership | path | required | string | idMembership |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_memberships"
}
}
},
"required": true,
"description": "Attributes of \"Boards Memberships\" to be updated."
}
PUT /boards/{idBoard}/memberships/{idMembership}
/boards/{idBoard}/myPrefs/emailPosition
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_emailPosition"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Email Position\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/emailPosition
/boards/{idBoard}/myPrefs/idEmailList
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_idEmailList"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Id Email List\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/idEmailList
/boards/{idBoard}/myPrefs/showListGuide
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_showListGuide"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Show List Guide\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/showListGuide
/boards/{idBoard}/myPrefs/showSidebar
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_showSidebar"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Show Sidebar\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/showSidebar
/boards/{idBoard}/myPrefs/showSidebarActivity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_showSidebarActivity"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Show Sidebar Activity\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/showSidebarActivity
/boards/{idBoard}/myPrefs/showSidebarBoardActions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_showSidebarBoardActions"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Show Sidebar Board Actions\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/showSidebarBoardActions
/boards/{idBoard}/myPrefs/showSidebarMembers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/myPrefs_showSidebarMembers"
}
}
},
"required": true,
"description": "Attributes of \"My Prefs Show Sidebar Members\" to be updated."
}
PUT /boards/{idBoard}/myPrefs/showSidebarMembers
/boards/{idBoard}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_name"
}
}
},
"required": true,
"description": "Attributes of \"Boards Name\" to be updated."
}
PUT /boards/{idBoard}/name
/boards/{idBoard}/prefs/background
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_background"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Background\" to be updated."
}
PUT /boards/{idBoard}/prefs/background
/boards/{idBoard}/prefs/calendarFeedEnabled
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_calendarFeedEnabled"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Calendar Feed Enabled\" to be updated."
}
PUT /boards/{idBoard}/prefs/calendarFeedEnabled
/boards/{idBoard}/prefs/cardAging
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_cardAging"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Card Aging\" to be updated."
}
PUT /boards/{idBoard}/prefs/cardAging
/boards/{idBoard}/prefs/cardCovers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_cardCovers"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Card Covers\" to be updated."
}
PUT /boards/{idBoard}/prefs/cardCovers
/boards/{idBoard}/prefs/comments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_comments"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Comments\" to be updated."
}
PUT /boards/{idBoard}/prefs/comments
/boards/{idBoard}/prefs/invitations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_invitations"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Invitations\" to be updated."
}
PUT /boards/{idBoard}/prefs/invitations
/boards/{idBoard}/prefs/permissionLevel
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"$ref": "#/components/requestBodies/prefs_permissionLevel"
}
PUT /boards/{idBoard}/prefs/permissionLevel
/boards/{idBoard}/prefs/selfJoin
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_selfJoin"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Self Join\" to be updated."
}
PUT /boards/{idBoard}/prefs/selfJoin
/boards/{idBoard}/prefs/voting
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_voting"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Voting\" to be updated."
}
PUT /boards/{idBoard}/prefs/voting
/boards/{idBoard}/subscribed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idBoard | path | required | string | board_id |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/boards_subscribed"
}
}
},
"required": true,
"description": "Attributes of \"Boards Subscribed\" to be updated."
}
PUT /boards/{idBoard}/subscribed
/cards/{idCard}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards"
}
}
},
"required": true,
"description": "Attributes of \"Cards\" to be updated."
}
PUT /cards/{idCard}
/cards/{idCard}/actions/{idAction}/comments
This can only be done by the original author of the comment.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idAction | path | required | string | idAction |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_actions_comments"
}
}
},
"required": true,
"description": "Attributes of \"Cards Actions Comments\" to be updated."
}
PUT /cards/{idCard}/actions/{idAction}/comments
/cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklistCurrent | path | required | string | idChecklistCurrent |
| idCheckItem | path | required | string | idCheckItem |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklist_idChecklistCurrent_checkItem"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklist Id Checklist Current Check Item\" to be updated."
}
PUT /cards/{idCard}/checklist/{idChecklistCurrent}/checkItem/{idCheckItem}
/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklist | path | required | string | idChecklist |
| idCheckItem | path | required | string | idCheckItem |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklist_checkItem_name"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklist Check Item Name\" to be updated."
}
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/name
/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklist | path | required | string | idChecklist |
| idCheckItem | path | required | string | idCheckItem |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklist_checkItem_pos"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklist Check Item Pos\" to be updated."
}
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/pos
/cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idChecklist | path | required | string | idChecklist |
| idCheckItem | path | required | string | idCheckItem |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_checklist_checkItem_state"
}
}
},
"required": true,
"description": "Attributes of \"Cards Checklist Check Item State\" to be updated."
}
PUT /cards/{idCard}/checklist/{idChecklist}/checkItem/{idCheckItem}/state
/cards/{idCard}/closed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_closed"
}
}
},
"required": true,
"description": "Attributes of \"Cards Closed\" to be updated."
}
PUT /cards/{idCard}/closed
/cards/{idCard}/desc
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_desc"
}
}
},
"required": true,
"description": "Attributes of \"Cards Desc\" to be updated."
}
PUT /cards/{idCard}/desc
/cards/{idCard}/due
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_due"
}
}
},
"required": true,
"description": "Attributes of \"Cards Due\" to be updated."
}
PUT /cards/{idCard}/due
/cards/{idCard}/idAttachmentCover
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idAttachmentCover"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id Attachment Cover\" to be updated."
}
PUT /cards/{idCard}/idAttachmentCover
/cards/{idCard}/idBoard
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idBoard"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id Board\" to be updated."
}
PUT /cards/{idCard}/idBoard
/cards/{idCard}/idList
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idList"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id List\" to be updated."
}
PUT /cards/{idCard}/idList
/cards/{idCard}/idMembers
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_idMembers"
}
}
},
"required": true,
"description": "Attributes of \"Cards Id Members\" to be updated."
}
PUT /cards/{idCard}/idMembers
/cards/{idCard}/labels
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_labels"
}
}
},
"required": true,
"description": "Attributes of \"Cards Labels\" to be updated."
}
PUT /cards/{idCard}/labels
/cards/{idCard}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_name"
}
}
},
"required": true,
"description": "Attributes of \"Cards Name\" to be updated."
}
PUT /cards/{idCard}/name
/cards/{idCard}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_pos"
}
}
},
"required": true,
"description": "Attributes of \"Cards Pos\" to be updated."
}
PUT /cards/{idCard}/pos
/cards/{idCard}/stickers/{idSticker}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
| idSticker | path | required | string | idSticker |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_stickers"
}
}
},
"required": true,
"description": "Attributes of \"Cards Stickers\" to be updated."
}
PUT /cards/{idCard}/stickers/{idSticker}
/cards/{idCard}/subscribed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idCard | path | required | string | card id or shortlink |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cards_subscribed"
}
}
},
"required": true,
"description": "Attributes of \"Cards Subscribed\" to be updated."
}
PUT /cards/{idCard}/subscribed
/checklists/{idChecklist}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists"
}
}
},
"required": true,
"description": "Attributes of \"Checklists\" to be updated."
}
PUT /checklists/{idChecklist}
/checklists/{idChecklist}/idCard
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists_idCard"
}
}
},
"required": true,
"description": "Attributes of \"Checklists Id Card\" to be updated."
}
PUT /checklists/{idChecklist}/idCard
/checklists/{idChecklist}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists_name"
}
}
},
"required": true,
"description": "Attributes of \"Checklists Name\" to be updated."
}
PUT /checklists/{idChecklist}/name
/checklists/{idChecklist}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idChecklist | path | required | string | idChecklist |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/checklists_pos"
}
}
},
"required": true,
"description": "Attributes of \"Checklists Pos\" to be updated."
}
PUT /checklists/{idChecklist}/pos
/labels/{idLabel}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labels"
}
}
},
"required": true,
"description": "Attributes of \"Labels\" to be updated."
}
PUT /labels/{idLabel}
/labels/{idLabel}/color
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labels_color"
}
}
},
"required": true,
"description": "Attributes of \"Labels Color\" to be updated."
}
PUT /labels/{idLabel}/color
/labels/{idLabel}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idLabel | path | required | string | idLabel |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/labels_name"
}
}
},
"required": true,
"description": "Attributes of \"Labels Name\" to be updated."
}
PUT /labels/{idLabel}/name
/lists/{idList}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists"
}
}
},
"required": true,
"description": "Attributes of \"Lists\" to be updated."
}
PUT /lists/{idList}
/lists/{idList}/closed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_closed"
}
}
},
"required": true,
"description": "Attributes of \"Lists Closed\" to be updated."
}
PUT /lists/{idList}/closed
/lists/{idList}/idBoard
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_idBoard"
}
}
},
"required": true,
"description": "Attributes of \"Lists Id Board\" to be updated."
}
PUT /lists/{idList}/idBoard
/lists/{idList}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_name"
}
}
},
"required": true,
"description": "Attributes of \"Lists Name\" to be updated."
}
PUT /lists/{idList}/name
/lists/{idList}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_pos"
}
}
},
"required": true,
"description": "Attributes of \"Lists Pos\" to be updated."
}
PUT /lists/{idList}/pos
/lists/{idList}/subscribed
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idList | path | required | string | idList |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lists_subscribed"
}
}
},
"required": true,
"description": "Attributes of \"Lists Subscribed\" to be updated."
}
PUT /lists/{idList}/subscribed
/members/{idMember}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members"
}
}
},
"required": true,
"description": "Attributes of \"Members\" to be updated."
}
PUT /members/{idMember}
/members/{idMember}/avatarSource
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_avatarSource"
}
}
},
"required": true,
"description": "Attributes of \"Members Avatar Source\" to be updated."
}
PUT /members/{idMember}/avatarSource
/members/{idMember}/bio
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_bio"
}
}
},
"required": true,
"description": "Attributes of \"Members Bio\" to be updated."
}
PUT /members/{idMember}/bio
/members/{idMember}/boardBackgrounds/{idBoardBackground}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardBackground | path | required | string | idBoardBackground |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardBackgrounds"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Backgrounds\" to be updated."
}
PUT /members/{idMember}/boardBackgrounds/{idBoardBackground}
/members/{idMember}/boardStars/{idBoardStar}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardStar | path | required | string | idBoardStar |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardStars"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Stars\" to be updated."
}
PUT /members/{idMember}/boardStars/{idBoardStar}
/members/{idMember}/boardStars/{idBoardStar}/idBoard
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardStar | path | required | string | idBoardStar |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardStars_idBoard"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Stars Id Board\" to be updated."
}
PUT /members/{idMember}/boardStars/{idBoardStar}/idBoard
/members/{idMember}/boardStars/{idBoardStar}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardStar | path | required | string | idBoardStar |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_boardStars_pos"
}
}
},
"required": true,
"description": "Attributes of \"Members Board Stars Pos\" to be updated."
}
PUT /members/{idMember}/boardStars/{idBoardStar}/pos
/members/{idMember}/customBoardBackgrounds/{idBoardBackground}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idBoardBackground | path | required | string | idBoardBackground |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_customBoardBackgrounds"
}
}
},
"required": true,
"description": "Attributes of \"Members Custom Board Backgrounds\" to be updated."
}
PUT /members/{idMember}/customBoardBackgrounds/{idBoardBackground}
/members/{idMember}/fullName
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_fullName"
}
}
},
"required": true,
"description": "Attributes of \"Members Full Name\" to be updated."
}
PUT /members/{idMember}/fullName
/members/{idMember}/initials
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_initials"
}
}
},
"required": true,
"description": "Attributes of \"Members Initials\" to be updated."
}
PUT /members/{idMember}/initials
/members/{idMember}/prefs/colorBlind
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_colorBlind"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Color Blind\" to be updated."
}
PUT /members/{idMember}/prefs/colorBlind
/members/{idMember}/prefs/locale
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_locale"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Locale\" to be updated."
}
PUT /members/{idMember}/prefs/locale
/members/{idMember}/prefs/minutesBetweenSummaries
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_minutesBetweenSummaries"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Minutes Between Summaries\" to be updated."
}
PUT /members/{idMember}/prefs/minutesBetweenSummaries
/members/{idMember}/savedSearches/{idSavedSearch}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idSavedSearch | path | required | string | idSavedSearch |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_savedSearches"
}
}
},
"required": true,
"description": "Attributes of \"Members Saved Searches\" to be updated."
}
PUT /members/{idMember}/savedSearches/{idSavedSearch}
/members/{idMember}/savedSearches/{idSavedSearch}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idSavedSearch | path | required | string | idSavedSearch |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_savedSearches_name"
}
}
},
"required": true,
"description": "Attributes of \"Members Saved Searches Name\" to be updated."
}
PUT /members/{idMember}/savedSearches/{idSavedSearch}/name
/members/{idMember}/savedSearches/{idSavedSearch}/pos
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idSavedSearch | path | required | string | idSavedSearch |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_savedSearches_pos"
}
}
},
"required": true,
"description": "Attributes of \"Members Saved Searches Pos\" to be updated."
}
PUT /members/{idMember}/savedSearches/{idSavedSearch}/pos
/members/{idMember}/savedSearches/{idSavedSearch}/query
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
| idSavedSearch | path | required | string | idSavedSearch |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_savedSearches_query"
}
}
},
"required": true,
"description": "Attributes of \"Members Saved Searches Query\" to be updated."
}
PUT /members/{idMember}/savedSearches/{idSavedSearch}/query
/members/{idMember}/username
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idMember | path | required | string | idMember or username |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/members_username"
}
}
},
"required": true,
"description": "Attributes of \"Members Username\" to be updated."
}
PUT /members/{idMember}/username
/notifications/{idNotification}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notifications"
}
}
},
"required": true,
"description": "Attributes of \"Notifications\" to be updated."
}
PUT /notifications/{idNotification}
/notifications/{idNotification}/unread
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idNotification | path | required | string | idNotification |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notifications_unread"
}
}
},
"required": true,
"description": "Attributes of \"Notifications Unread\" to be updated."
}
PUT /notifications/{idNotification}/unread
/organizations/{idOrg}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations"
}
}
},
"required": true,
"description": "Attributes of \"Organizations\" to be updated."
}
PUT /organizations/{idOrg}
/organizations/{idOrg}/desc
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_desc"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Desc\" to be updated."
}
PUT /organizations/{idOrg}/desc
/organizations/{idOrg}/displayName
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_displayName"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Display Name\" to be updated."
}
PUT /organizations/{idOrg}/displayName
/organizations/{idOrg}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"$ref": "#/components/requestBodies/organizations_members"
}
PUT /organizations/{idOrg}/members
/organizations/{idOrg}/members/{idMember}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| idMember | path | required | string | idMember |
{
"$ref": "#/components/requestBodies/organizations_members"
}
PUT /organizations/{idOrg}/members/{idMember}
/organizations/{idOrg}/members/{idMember}/deactivated
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| idMember | path | required | string | idMember |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_members_deactivated"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Members Deactivated\" to be updated."
}
PUT /organizations/{idOrg}/members/{idMember}/deactivated
/organizations/{idOrg}/memberships/{idMembership}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
| idMembership | path | required | string | idMembership |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_memberships"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Memberships\" to be updated."
}
PUT /organizations/{idOrg}/memberships/{idMembership}
/organizations/{idOrg}/name
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_name"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Name\" to be updated."
}
PUT /organizations/{idOrg}/name
/organizations/{idOrg}/prefs/associatedDomain
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_associatedDomain"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Associated Domain\" to be updated."
}
PUT /organizations/{idOrg}/prefs/associatedDomain
/organizations/{idOrg}/prefs/boardVisibilityRestrict/org
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/org
/organizations/{idOrg}/prefs/boardVisibilityRestrict/private
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/private
/organizations/{idOrg}/prefs/boardVisibilityRestrict/public
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"$ref": "#/components/requestBodies/prefs_boardVisibilityRestrict"
}
PUT /organizations/{idOrg}/prefs/boardVisibilityRestrict/public
/organizations/{idOrg}/prefs/externalMembersDisabled
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_externalMembersDisabled"
}
}
},
"required": true,
"description": "Attributes of \"Prefs External Members Disabled\" to be updated."
}
PUT /organizations/{idOrg}/prefs/externalMembersDisabled
/organizations/{idOrg}/prefs/googleAppsVersion
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_googleAppsVersion"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Google Apps Version\" to be updated."
}
PUT /organizations/{idOrg}/prefs/googleAppsVersion
/organizations/{idOrg}/prefs/orgInviteRestrict
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/prefs_orgInviteRestrict"
}
}
},
"required": true,
"description": "Attributes of \"Prefs Org Invite Restrict\" to be updated."
}
PUT /organizations/{idOrg}/prefs/orgInviteRestrict
/organizations/{idOrg}/prefs/permissionLevel
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"$ref": "#/components/requestBodies/prefs_permissionLevel"
}
PUT /organizations/{idOrg}/prefs/permissionLevel
/organizations/{idOrg}/website
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idOrg | path | required | string | idOrg or name |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/organizations_website"
}
}
},
"required": true,
"description": "Attributes of \"Organizations Website\" to be updated."
}
PUT /organizations/{idOrg}/website
/sessions/{idSession}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idSession | path | required | string | idSession |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sessions"
}
}
},
"required": true,
"description": "Attributes of \"Sessions\" to be updated."
}
PUT /sessions/{idSession}
/sessions/{idSession}/status
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idSession | path | required | string | idSession |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sessions_status"
}
}
},
"required": true,
"description": "Attributes of \"Sessions Status\" to be updated."
}
PUT /sessions/{idSession}/status
/tokens/{token}/webhooks
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tokens_webhooks"
}
}
},
"required": true,
"description": "Attributes of \"Tokens Webhooks\" to be updated."
}
PUT /tokens/{token}/webhooks
/webhooks
{
"$ref": "#/components/requestBodies/webhooks"
}
PUT /webhooks
/webhooks/{idWebhook}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
{
"$ref": "#/components/requestBodies/webhooks"
}
PUT /webhooks/{idWebhook}
/webhooks/{idWebhook}/active
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhooks_active"
}
}
},
"required": true,
"description": "Attributes of \"Webhooks Active\" to be updated."
}
PUT /webhooks/{idWebhook}/active
/webhooks/{idWebhook}/callbackURL
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhooks_callbackURL"
}
}
},
"required": true,
"description": "Attributes of \"Webhooks Callback Url\" to be updated."
}
PUT /webhooks/{idWebhook}/callbackURL
/webhooks/{idWebhook}/description
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhooks_description"
}
}
},
"required": true,
"description": "Attributes of \"Webhooks Description\" to be updated."
}
PUT /webhooks/{idWebhook}/description
/webhooks/{idWebhook}/idModel
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| idWebhook | path | required | string | idWebhook |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhooks_idModel"
}
}
},
"required": true,
"description": "Attributes of \"Webhooks Id Model\" to be updated."
}
PUT /webhooks/{idWebhook}/idModel
actions
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
actions_text
{
"xml": {
"name": "action"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"powerUps": {
"type": "string",
"description": "all or a comma-separated list of: calendar, cardAging, recap or voting"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"prefs/voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_voting": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"idBoardSource": {
"type": "string",
"description": "The id of the board to copy into the new board"
},
"idOrganization": {
"type": "string",
"description": "The id or name of the organization to add the board to."
},
"keepFromSource": {
"type": "string",
"description": "Components of the source board to copy."
},
"labelNames/red": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs/selfJoin": {
"type": "string",
"description": " true or false"
},
"prefs_comments": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
},
"prefs_selfJoin": {
"type": "string",
"description": " true or false"
},
"labelNames/blue": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"prefs_cardAging": {
"type": "string",
"description": "One of: pirate or regular"
},
"labelNames/green": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/background": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
},
"prefs/cardCovers": {
"type": "string",
"description": " true or false"
},
"prefs_background": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs_cardCovers": {
"type": "string",
"description": " true or false"
},
"labelNames/orange": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/purple": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"labelNames/yellow": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"prefs/invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs_invitations": {
"type": "string",
"description": "One of: admins or members"
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs_permissionLevel": {
"type": "string",
"description": "One of: org, private or public"
},
"prefs/calendarFeedEnabled": {
"type": "string",
"description": " true or false"
}
}
}
boards_checklists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_closed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
boards_desc
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_idOrganization
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
boards_labels
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
}
}
}
boards_lists
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_members
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
boards_memberships
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
boards_name
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
boards_powerUps
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: calendar, cardAging, recap or voting"
}
}
}
boards_subscribed
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "The name of the new card. It isn't required if the name is being copied from provided by a URL, file or card that is being copied."
},
"closed": {
"type": "string",
"description": " true or false"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be added to"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idBoard": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idLabels": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
},
"urlSource": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"fileSource": {
"type": "string",
"description": "A file"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idCardSource": {
"type": "string",
"description": "The id of the card to copy into a new card."
},
"keepFromSource": {
"type": "string",
"description": "Properties of the card to copy over from the source."
},
"idAttachmentCover": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_actions_comments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_attachments
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 256"
},
"mimeType": {
"type": "string",
"description": "a string with a length from 0 to 256"
}
}
}
cards_checklist_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_checklist_checkItem_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_checklist_checkItem_state
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
}
}
}
cards_checklist_idChecklistCurrent_checkItem
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"state": {
"type": "string",
"description": "One of: complete, false, incomplete or true"
},
"idChecklist": {
"type": "string",
"description": "An id, or null"
}
}
}
cards_checklists
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"value": {
"type": "string",
"description": "The id of the checklist to add to the card, or null to create a new one."
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
cards_closed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
cards_desc
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
cards_due
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A date, or null"
}
}
}
cards_idAttachmentCover
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Id of the image attachment of this card to use as its cover, or null for no cover"
}
}
}
cards_idBoard
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the board the card should be moved to"
},
"idList": {
"type": "string",
"description": "id of the list that the card should be moved to on the new board"
}
}
}
cards_idLabels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the label to add"
}
}
}
cards_idList
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the list the card should be moved to"
}
}
}
cards_idMembers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to add to the card"
}
}
}
cards_labels
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"value": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
}
}
}
cards_membersVoted
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the member to vote 'yes' on the card"
}
}
}
cards_name
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
cards_pos
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
cards_stickers
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"top": {
"type": "string",
"description": "undefined"
},
"left": {
"type": "string",
"description": "undefined"
},
"image": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"rotate": {
"type": "string",
"description": "undefined"
},
"zIndex": {
"type": "string",
"description": "Valid Z values for stickers, must be an integer"
}
}
}
cards_subscribed
{
"xml": {
"name": "card"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
checklists
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"idCard": {
"type": "string",
"description": "id of the card that the checklist should be added to"
},
"idBoard": {
"type": "string",
"description": "id of the board that the checklist should be added to"
},
"idChecklistSource": {
"type": "string",
"description": "The id of the source checklist to copy into a new checklist."
}
}
}
checklists_checkItems
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"checked": {
"type": "string",
"description": " true or false"
}
}
}
checklists_idCard
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The id of the card that the checklist is on"
}
}
}
checklists_name
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
checklists_pos
{
"xml": {
"name": "checklist"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
labelNames_blue
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_green
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_orange
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_purple
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_red
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labelNames_yellow
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
labels
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"color": {
"type": "string",
"description": "A valid label color or null"
},
"idBoard": {
"type": "string",
"description": "An id"
}
}
}
labels_color
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid label color or null"
}
}
}
labels_name
{
"xml": {
"name": "label"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
lists
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"closed": {
"type": "string",
"description": " true or false"
},
"idBoard": {
"type": "string",
"description": "id of the board that the list should be added to"
},
"subscribed": {
"type": "string",
"description": " true or false"
},
"idListSource": {
"type": "string",
"description": "The id of the list to copy into a new list."
}
}
}
lists_cards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"due": {
"type": "string",
"description": "A date, or null"
},
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 1 to 16384"
},
"labels": {
"type": "string",
"description": "all or a comma-separated list of: blue, green, orange, purple, red or yellow"
},
"idMembers": {
"type": "string",
"description": "A comma-separated list of objectIds, 24-character hex strings"
}
}
}
lists_closed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
lists_idBoard
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "position of the list on the new board"
},
"value": {
"type": "string",
"description": "id of the board the list should be moved to"
}
}
}
lists_moveAllCards
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"idBoard": {
"type": "string",
"description": "id of the board that the cards should be moved to"
}
}
}
lists_name
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
lists_pos
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
lists_subscribed
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
members
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"bio": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"initials": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
},
"username": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
},
"avatarSource": {
"type": "string",
"description": "One of: gravatar, none or upload"
},
"prefs/locale": {
"type": "string",
"description": "a string with a length from 0 to 255"
},
"prefs/colorBlind": {
"type": "string",
"description": " true or false"
},
"prefs/minutesBetweenSummaries": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
members_avatar
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_avatarSource
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: gravatar, none or upload"
}
}
}
members_bio
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
members_boardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_boardStars
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"idBoard": {
"type": "string",
"description": "The id of the board to star"
}
}
}
members_boardStars_idBoard
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
members_boardStars_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_customBoardBackgrounds
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"tile": {
"type": "string",
"description": " true or false"
},
"brightness": {
"type": "string",
"description": "One of: dark, light or unknown"
}
}
}
members_customEmoji
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
},
"name": {
"type": "string",
"description": "a string with a length from 2 to 64"
}
}
}
members_customStickers
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
members_fullName
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
members_initials
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length from 1 to 4. Cannot begin or end with a space"
}
}
}
members_oneTimeMessagesDismissed
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Type of message dismissed"
}
}
}
members_savedSearches
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"pos": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
},
"name": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
},
"query": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_savedSearches_name
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A non-empty string with at least one non-space character"
}
}
}
members_savedSearches_pos
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A position. top , bottom , or a positive number."
}
}
}
members_savedSearches_query
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 1 to 16384"
}
}
}
members_username
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
myPrefs_emailPosition
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: bottom or top"
}
}
}
myPrefs_idEmailList
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An id"
}
}
}
myPrefs_showListGuide
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebar
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarActivity
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarBoardActions
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
myPrefs_showSidebarMembers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
notifications
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"unread": {
"type": "string",
"description": " true or false"
}
}
}
notifications_unread
{
"xml": {
"name": "notification"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"desc": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"name": {
"type": "string",
"description": "a string with a length from 0 to 16384"
},
"website": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
},
"displayName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
},
"prefs/permissionLevel": {
"type": "string",
"description": "One of: private or public"
},
"prefs/associatedDomain": {
"type": "string",
"description": "The google apps domain to link this org to."
},
"prefs/googleAppsVersion": {
"type": "string",
"description": "a number from 1 to 2"
},
"prefs/orgInviteRestrict": {
"type": "string",
"description": "An email address with optional expansion tokens"
},
"prefs/externalMembersDisabled": {
"type": "string",
"description": " true or false"
},
"prefs/boardVisibilityRestrict/org": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/public": {
"type": "string",
"description": "One of: admin, none or org"
},
"prefs/boardVisibilityRestrict/private": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
organizations_desc
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
organizations_displayName
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_logo
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "A file"
}
}
}
organizations_members
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"email": {
"type": "string",
"description": "An email address"
},
"fullName": {
"type": "string",
"description": "A string with a length of at least 1. Cannot begin or end with a space."
}
}
}
organizations_members_deactivated
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
organizations_memberships
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "One of: admin, normal or observer"
},
"member_fields": {
"type": "string",
"description": "all or a comma-separated list of: avatarHash, bio, bioData, confirmed, fullName, idPremOrgsAdmin, initials, memberType, products, status, url or username"
}
}
}
organizations_name
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique."
}
}
}
organizations_website
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A URL starting with http:// or https:// or null"
}
}
}
prefs_associatedDomain
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The google apps domain to link this org to."
}
}
}
prefs_background
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A standard background name, or the id of a custom background"
}
}
}
prefs_boardVisibilityRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admin, none or org"
}
}
}
prefs_calendarFeedEnabled
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_cardAging
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: pirate or regular"
}
}
}
prefs_cardCovers
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_colorBlind
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_comments
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
prefs_externalMembersDisabled
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_googleAppsVersion
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a number from 1 to 2"
}
}
}
prefs_invitations
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: admins or members"
}
}
}
prefs_locale
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 255"
}
}
}
prefs_minutesBetweenSummaries
{
"xml": {
"name": "member"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "-1 (disabled), 1 or 60"
}
}
}
prefs_orgInviteRestrict
{
"xml": {
"name": "organization"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "An email address with optional expansion tokens"
}
}
}
prefs_permissionLevel
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: private or public"
}
}
}
prefs_selfJoin
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
prefs_voting
{
"xml": {
"name": "board"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: disabled, members, observers, org or public"
}
}
}
sessions
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "One of: active, disconnected or idle"
},
"idBoard": {
"type": "string",
"description": "The id of the board you're viewing. Boards with no viewers will not get updates about members' statuses."
}
}
}
sessions_status
{
"xml": {
"name": "session"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "One of: active, disconnected or idle"
}
}
}
tokens_webhooks
{
"xml": {
"name": "token"
},
"type": "object",
"properties": {
"idModel": {
"type": "string",
"description": "id of the model to be monitored"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"active": {
"type": "string",
"description": " true or false"
},
"idModel": {
"type": "string",
"description": "id of the model that should be hooked"
},
"callbackURL": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
},
"description": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_active
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": " true or false"
}
}
}
webhooks_callbackURL
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "A valid URL that is reachable with a HEAD request"
}
}
}
webhooks_description
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "a string with a length from 0 to 16384"
}
}
}
webhooks_idModel
{
"xml": {
"name": "webhook"
},
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "id of the model to be monitored"
}
}
}