Organisations
Allow or stop guests on the organisation's boards
The owner's setting, off by default.
PUT
/orgs/{org}/sharing/board-guestsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Allow or stop guests on the organisation's boards. |
| What does it take? | A JSON body of type SetOrgBoardGuestsBody. |
| What does it return? | Status 200 with a body of type OrgBoardGuestsChanged. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 only the owner may (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 live whiteboards are not available on this server. Every failure uses the one error envelope. |
What it does
The owner's setting, off by default. On, a person who manages a board may share it with "Anyone with the link who is signed in", and then every signed-in Plotwork account opens it read only and sees nothing else of the organisation. A Confidential board never opens for a guest. Off closes every guest's live connection at once, and guestsClosed says how many; each board keeps its own choice for when it is turned on again. Only the owner may. Audited as orgs.settings.board_guests.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SetOrgBoardGuestsBody.
| Field | Type | Required | Description |
|---|---|---|---|
allowGuests | boolean | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The setting now, and how many guests were closed out. | OrgBoardGuestsChanged |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner may (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Live whiteboards are not available on this server. | ErrorResponse |
Response body
A 200 answer has the type OrgBoardGuestsChanged.
| Field | Type | Required | Description |
|---|---|---|---|
allowGuests | boolean | yes | Whether a board may be shared with anyone signed in, read only. Off by default. |
sharedBoards | integer | yes | Boards that share their link with guests now (their label is not Confidential). |
guestsClosed | integer | yes | Guests' live connections that turning it off closed. |
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 |