# Choose the legend of an organisation's diagrams

> Page: https://docs.plotwork.dev/api/put-orgs-org-legend. Index of every page: https://docs.plotwork.dev/llms.txt

members, on, off, or required, for the flow diagrams drawn for the organisation on the hosted service.

`PUT /orgs/{org}/legend`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Choose the legend of an organisation's diagrams. |
| What does it take? | A JSON body of type [`SetOrganisationLegendBody`](https://docs.plotwork.dev/api/schemas.md#setorganisationlegendbody). |
| What does it return? | Status 200 with a body of type [`OrganisationLegend`](https://docs.plotwork.dev/api/schemas.md#organisationlegend). |
| What can go wrong? | `400` the body is not valid; `401` not signed in; `403` the role may not (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` organisations are not set up on this server. Every failure uses the one error envelope. |

## What it does

members, on, off, or required, for the flow diagrams drawn for the organisation on the hosted service. The owner or an admin.

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `org` | `string` | yes | The organisation's id or its slug. |

## Request body

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

| Field | Type | Required | Description |
|---|---|---|---|
| `legend` | `"members" \| "on" \| "off" \| "required"` | yes |  |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The choice now. | [`OrganisationLegend`](https://docs.plotwork.dev/api/schemas.md#organisationlegend) |
| 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) |
| 403 | The role may not (orgs.forbidden), or the request came from an origin that may not make changes. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 404 | No such organisation, or the caller is not a member of it. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 503 | Organisations are not set up on this server. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

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

| Field | Type | Required | Description |
|---|---|---|---|
| `legend` | `"members" \| "on" \| "off" \| "required"` | yes | The legend of flow diagrams drawn for the organisation on the hosted service: members (each member's own choice, the default), on or off (a repository's plotwork.config.json and a diagram's header still win), or required (drawn whatever a repository or a header says). |

## 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 |