Organisations
Allow or stop diagrams on chosen websites
The owner's setting.
PUT
/orgs/{org}/sharing/embed-linksTL;DR
| Question | Answer |
|---|---|
| What does it do? | Allow or stop diagrams on chosen websites. |
| What does it take? | A JSON body of type SetOrganisationEmbedLinksBody. |
| What does it return? | Status 200 with a body of type OrganisationEmbedLinksChanged. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 only the owner may (orgs.forbidden), not on the plan (plan.embed_links_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
The owner's setting. On, diagrams may have embed links for named websites (Enterprise). Off ends every embed link at once. Only the owner may.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SetOrganisationEmbedLinksBody.
| Field | Type | Required | Description |
|---|---|---|---|
embedLinks | boolean | yes | True to allow diagrams on chosen websites; false to end every embed link. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The setting now, and how many links ended. | OrganisationEmbedLinksChanged |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | Only the owner may (orgs.forbidden), not on the plan (plan.embed_links_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 OrganisationEmbedLinksChanged.
| Field | Type | Required | Description |
|---|---|---|---|
embedLinks | boolean | yes | |
linksEnded | integer | yes | How many embed links this call ended: every one when the setting was turned off, none otherwise. minimum 0. |
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 |