Organisations
Ask for access to a board
Asks the people who manage the board to let the caller open it, with an optional note.
POST
/user/boards/{board}/access-requestsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Ask for access to a board. |
| What does it take? | A JSON body of type BoardAccessRequestBody. |
| What does it return? | Status 202 with no body. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 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
Asks the people who manage the board to let the caller open it, with an optional note. The answer is 202 whether the board exists or not, so it reveals nothing. At most three requests a person a board a day are kept and emailed; a request goes after 30 days.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
board | string | yes |
Request body
The body has the type BoardAccessRequestBody.
| Field | Type | Required | Description |
|---|---|---|---|
note | string | no | at most 200 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 202 | Received. | none |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | 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 |