Organisations
Make an invite link for a board
A link that adds any member of the organisation who opens it to the board, with view or edit, for 30 days.
POST
/orgs/{org}/boards/{board}/join-linksTL;DR
| Question | Answer |
|---|---|
| What does it do? | Make an invite link for a board. |
| What does it take? | A JSON body of type CreateBoardJoinLinkBody. |
| What does it return? | Status 201 with a body of type NewBoardJoinLink. |
| 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
A link that adds any member of the organisation who opens it to the board, with view or edit, for 30 days. It never admits a person outside the organisation. The link is in the answer once; only a hash of its token is kept.
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 CreateBoardJoinLinkBody.
| Field | Type | Required | Description |
|---|---|---|---|
role | "view" | "edit" | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 201 | The link, shown once. | NewBoardJoinLink |
| 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 |
Response body
A 201 answer has the type NewBoardJoinLink.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
role | "view" | "edit" | yes | |
createdAt | integer | yes | |
expiresAt | integer | yes | |
url | string | yes | The link to share. Its token is not stored and cannot be shown again. |
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 |