Organisations
Rename an organisation
Changes the name.
PATCH
/orgs/{org}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Rename an organisation. |
| What does it take? | A JSON body of type RenameOrganisationBody. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 the caller's role may not rename (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; 422 the name holds a word that is not allowed in a name (orgs.name_not_allowed); 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Changes the name. The owner and an admin may. The slug never changes.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type RenameOrganisationBody.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | What people read. 1 to 60 characters. It can be changed; the slug cannot. at least 1 character; pattern ^[^\p{Cc}]+$/u. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Renamed. | none |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The caller's role may not rename (orgs.forbidden), 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 |
| 422 | The name holds a word that is not allowed in a name (orgs.name_not_allowed). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
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 |