Organisations
Record an export of a board
The portal makes every export in the browser and says what it made here, for the organisation audit log (orgs.board.export): the format and how many tabs.
POST
/orgs/{org}/boards/{board}/exportsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Record an export of a board. |
| What does it take? | A JSON body of type BoardExportBody. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, board or tab, or the board is not open to the caller: the cases look alike; 429 too many requests; 503 organisations or boards are not set up on this server. Every failure uses the one error envelope. |
What it does
The portal makes every export in the browser and says what it made here, for the organisation audit log (orgs.board.export): the format and how many tabs. Nothing of the board is sent.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
board | string | yes | The board's id: 22 letters and digits. |
Request body
The body has the type BoardExportBody.
| Field | Type | Required | Description |
|---|---|---|---|
format | "svg" | "png" | "diagram" | "markdown" | "view-link" | "pdf" | "pptx" | "zip" | yes | |
tabs | integer | yes | minimum 1; maximum 100. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Recorded. | none |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Boards are not turned on for this organisation (boards.not_enabled), the caller may look but not change it (boards.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations or boards are not set up on this server. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |