--- title: "Change an organization's details (owners)" description: "Fields left out are kept; null clears one." --- > Documentation Index > Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt > Use this file to discover all available pages before exploring further. Path: Pando API › orgs `PATCH /v1/orgs/{org}` Fields left out are kept; null clears one. ## Authentication Requires one of the following: - `credential`, http, header `Authorization` - `session`, apiKey, in cookie ## Path parameters - `updateOrg.path.org` (string, required) — An organization's login. Matched without case. - pattern `^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$` ## Request body _Required._ - `updateOrg.name` (string | null, optional) - maxLength 100 - `updateOrg.description` (string | null, optional) - maxLength 160 - `updateOrg.website` (string | null, optional) — An https URL. - maxLength 2048 ## Example request ```json { "name": "string", "description": "string", "website": "string" } ``` ## Code samples ### cURL ```curl curl --request PATCH \ --url https://app.gitpando.com/v1/orgs/string \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string", "website": "string" } ' ``` ### TypeScript ```typescript const url = 'https://app.gitpando.com/v1/orgs/string'; const options = { method: 'PATCH', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({name: 'string', description: 'string', website: 'string'}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://app.gitpando.com/v1/orgs/string" payload = { "name": "string", "description": "string", "website": "string" } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.patch(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 200 OK #### Example ```json { "type": "org", "login": "string", "name": "string", "description": "string", "website": "string", "created_at": "2019-08-24T14:15:22Z", "role": "owner", "members": 0 } ``` - `updateOrg.response.200.type` (string, required) - one of `"org"` - `updateOrg.response.200.login` (string, required) — A user's login, which is their namespace, or an organization's (one space for both): 1 to 39 lower-case letters, digits and single hyphens, no hyphen at either end (input in any case is lowered). Reserved, because a namespace is the first URL segment: v1, healthz, login, logout, settings, assets, fonts, new, api, app, static, orgs, users, docs, install. A login made at sign-in comes from the email's local part, skipping reserved and taken names (`base`, `base-2`, ... `base-999`, then a random tail). - pattern `^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$` - `updateOrg.response.200.name` (string | null, required) — The display name ("Plannotator"). - `updateOrg.response.200.description` (string | null, required) - `updateOrg.response.200.website` (string | null, required) — An https URL. - `updateOrg.response.200.created_at` (string, required) - format `date-time` - `updateOrg.response.200.role` (one of, required) — The caller's role in it; null when not in it. - one of: [MemberRole](/api/schemas/MemberRole/), `null` - `updateOrg.response.200.members` (integer | null, required) — How many people are in it; null for someone who is not in it. ### 400 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `updateOrg.response.400.error` (object, required) - `updateOrg.response.400.error.code` (string, required) - `updateOrg.response.400.error.message` (string, required) - `updateOrg.response.400.error.paths` (array, optional) - `updateOrg.response.400.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `updateOrg.response.400.error.checks.sha` (string | null, required) - `updateOrg.response.400.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `updateOrg.response.400.error.checks.required` (array | null, required) — Null while unknown. - `updateOrg.response.400.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `updateOrg.response.400.error.checks.statuses` (array, required) — The latest status per context. - `updateOrg.response.400.error.checks.statuses.sha` (string, required) - `updateOrg.response.400.error.checks.statuses.context` (string, required) - `updateOrg.response.400.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `updateOrg.response.400.error.checks.statuses.created_at` (string, required) - format `date-time` - `updateOrg.response.400.error.checks.statuses.target_url` (string | null, optional) - `updateOrg.response.400.error.checks.statuses.description` (string | null, optional) - `updateOrg.response.400.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `updateOrg.response.400.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `updateOrg.response.400.error.checks.missing` (array, optional) ### 403 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `updateOrg.response.403.error` (object, required) - `updateOrg.response.403.error.code` (string, required) - `updateOrg.response.403.error.message` (string, required) - `updateOrg.response.403.error.paths` (array, optional) - `updateOrg.response.403.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `updateOrg.response.403.error.checks.sha` (string | null, required) - `updateOrg.response.403.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `updateOrg.response.403.error.checks.required` (array | null, required) — Null while unknown. - `updateOrg.response.403.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `updateOrg.response.403.error.checks.statuses` (array, required) — The latest status per context. - `updateOrg.response.403.error.checks.statuses.sha` (string, required) - `updateOrg.response.403.error.checks.statuses.context` (string, required) - `updateOrg.response.403.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `updateOrg.response.403.error.checks.statuses.created_at` (string, required) - format `date-time` - `updateOrg.response.403.error.checks.statuses.target_url` (string | null, optional) - `updateOrg.response.403.error.checks.statuses.description` (string | null, optional) - `updateOrg.response.403.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `updateOrg.response.403.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `updateOrg.response.403.error.checks.missing` (array, optional) ### 404 An error #### Example ```json { "error": { "code": "string", "message": "string", "paths": [ "string" ], "checks": { "sha": "string", "state": "success", "required": [ "string" ], "checks_unknown": "string", "missing": [ "string" ], "statuses": [ { "sha": "string", "context": "string", "state": "pending", "target_url": "string", "description": "string", "creator": "string", "app": "string", "created_at": "2019-08-24T14:15:22Z" } ] } } } ``` - `updateOrg.response.404.error` (object, required) - `updateOrg.response.404.error.code` (string, required) - `updateOrg.response.404.error.message` (string, required) - `updateOrg.response.404.error.paths` (array, optional) - `updateOrg.response.404.error.checks` (object, optional) — GitHub's combined status, plus the required contexts and which are missing. - `updateOrg.response.404.error.checks.sha` (string | null, required) - `updateOrg.response.404.error.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused). - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"` - `updateOrg.response.404.error.checks.required` (array | null, required) — Null while unknown. - `updateOrg.response.404.error.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise. - `updateOrg.response.404.error.checks.statuses` (array, required) — The latest status per context. - `updateOrg.response.404.error.checks.statuses.sha` (string, required) - `updateOrg.response.404.error.checks.statuses.context` (string, required) - `updateOrg.response.404.error.checks.statuses.state` (string, required) - one of `"pending"`, `"success"`, `"failure"`, `"error"` - `updateOrg.response.404.error.checks.statuses.created_at` (string, required) - format `date-time` - `updateOrg.response.404.error.checks.statuses.target_url` (string | null, optional) - `updateOrg.response.404.error.checks.statuses.description` (string | null, optional) - `updateOrg.response.404.error.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:` for a status posted with a status token or by a CI integration; `hook:` for a status token from a web hook with no app. - `updateOrg.response.404.error.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows. - `updateOrg.response.404.error.checks.missing` (array, optional) Source: https://docs.gitpando.com/api/orgs/updateOrg/index.md