Organisations
Choose where an organisation's members publish
personal, organisation-default (a member's publish that names no organisation goes to the private library) or organisation-required (nothing a member publishes reaches a public link).
PUT
/orgs/{org}/publishingTL;DR
| Question | Answer |
|---|---|
| What does it do? | Choose where an organisation's members publish. |
| What does it take? | A JSON body of type SetOrganisationPublishingBody. |
| What does it return? | Status 200 with a body of type OrganisationPublishing. |
| What can go wrong? | 400 the body is not valid, or hideviewlinks was sent with a policy other than organisation-required; 401 not signed in; 403 the role may not (orgs.forbidden), the plan does not include organisation-required (plan.publishing_not_included), 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
personal, organisation-default (a member's publish that names no organisation goes to the private library) or organisation-required (nothing a member publishes reaches a public link). hideViewLinks, with organisation-required only, leaves view links out of hosted answers. The owner or an admin; organisation-required needs Pro or Enterprise.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SetOrganisationPublishingBody.
| Field | Type | Required | Description |
|---|---|---|---|
policy | "personal" | "organisation-default" | "organisation-required" | yes | |
hideViewLinks | boolean | no | Leave view links out of hosted answers for members and keys. Only with organisation-required. default false. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The setting now. | OrganisationPublishing |
| 400 | The body is not valid, or hideViewLinks was sent with a policy other than organisation-required. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The role may not (orgs.forbidden), the plan does not include organisation-required (plan.publishing_not_included), 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 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrganisationPublishing.
| Field | Type | Required | Description |
|---|---|---|---|
policy | "personal" | "organisation-default" | "organisation-required" | yes | What the owner or an admin chose: personal (members publish where they choose), organisation-default (a member's publish that names no organisation goes to this library), or organisation-required (nothing a member publishes reaches a public link). |
effective | "personal" | "organisation-default" | "organisation-required" | yes | What is enforced now: the choice, except organisation-required on a plan that no longer includes it, which acts as organisation-default. |
hideViewLinks | boolean | yes | Whether hosted answers leave view links out for members and the organisation's keys. Honoured only while effective is organisation-required. |
requiredAvailable | boolean | yes | Whether the organisation's plan includes organisation-required (Pro and Enterprise). |
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 |