# Join a board with an invite link

> Page: https://docs.plotwork.dev/api/post-user-boards-board-join. Index of every page: https://docs.plotwork.dev/llms.txt

Gives a member of the board organisation the role the invite link carries.

`POST /user/boards/{board}/join`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Join a board with an invite link. |
| What does it take? | A JSON body of type [`JoinBoardBody`](https://docs.plotwork.dev/api/schemas.md#joinboardbody). |
| What does it return? | Status 200 with a body of type [`BoardWhere`](https://docs.plotwork.dev/api/schemas.md#boardwhere). |
| What can go wrong? | `400` the body is not valid; `401` not signed in; `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

Gives a member of the board organisation the role the invite link carries. An unknown, revoked or expired link, and a person outside the organisation, all get 404 boards.join_invalid.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `board` | `string` | yes |  |

## Request body

The body has the type [`JoinBoardBody`](https://docs.plotwork.dev/api/schemas.md#joinboardbody).

| Field | Type | Required | Description |
|---|---|---|---|
| `token` | `string` | yes | at least 16 characters; at most 128 characters. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | Where the board is. | [`BoardWhere`](https://docs.plotwork.dev/api/schemas.md#boardwhere) |
| 400 | The body is not valid. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 401 | Not signed in. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such organisation, board or tab, or the board is not open to the caller: the cases look alike. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Organisations or boards are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`BoardWhere`](https://docs.plotwork.dev/api/schemas.md#boardwhere).

| Field | Type | Required | Description |
|---|---|---|---|
| `slug` | `string` | yes |  |
| `board` | `string` | yes | at least 22 characters; at most 22 characters; pattern `^[0-9A-Za-z]+$`. |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |