---
id: organization-update
title: "Update an organization"
description: "Updates information for an organization."
sidebar_label: "Update an organization"
hide_title: true
hide_table_of_contents: true
api: eJzdWM1uGzcQfpUBL02MtSz/9WcPBRQ1RRy0iRHbaABbMMbLscRkl9yQXNuKsLfe+zrt6/QF+grFkCtpJW1tp2hToD4sZHI4881w5uOQMyHJZVaVXhktUnFWSvTkQOlrYwvkUbg2FlCDsWPU6mMY64lEmJJs+OdIilS0Z9MqaBGJ8Dh2Ij0Xr1uzYpSIEi0W5Mny7ExoLEikQkmRCMUwSvQTkQhLHyplSYrU24qSNaynE4Kj78Bcg5/QCjzwBiIGBuqyCRUo0pnw05LtOG+VHou6ThamC/Io0eOl0lleSZoD+VCRnYp1y0NTFLjtiN3wJCFXzjOOuRYoLUfHK3IMpdEJSgekllxptKMeDG5Q5XiVE9xgXpGD84jVJcCRGzF6usOizAPsZi4E9T63RjFy5PwzI6cskRntSXv+iWWZqyyEaeedY3dmm6rM1TvKvEjE0hGejcGadewDz3TtRO9CX+hv4feff/vj119ga+uV8ZRubcFwgnqs9HhjwRcu6trakoYcaOMhY1kKki6vxltbCVxoQAfSsAZnIDNVLuHKEr6HzGhNGatycKv8BOhOOc+CLc8doJbgyN6ojFzvQnOurkSxHfihnZbewJHOeqJOhPPoK9cdhzjXGYkuE7oquDww8+om5lzzc9S234zVdSK88mGorfny1irP0yzgKKus8tNQV1eEluyg8hORno9iXsTcC/D3+v1NLwYa4u6DpdKSI+279ond+dtZtazr81j0IbESwdsrFgEeraefki1lSnsak92ozQG4qfNUbN8qSVBp9aEKNMEs1uXEIszffL23f7C7f7C7VyeLTF/fsQLvfiA95oB+2e8ipBUaYi29e1OJHU5nbbVf9Tfz5AEzrGXVTBbMbCudrSbsw4rvT+BPTNhkwatdWbBpfMGfuUFJEm4UBhiL8Qw95mYMg+OjFYdn4j1NRSoCjbLd1cQJk4/x/j1N567Pba4GljXVSWPnUSqD6L1KdZXndSJQSsXrML9cRX9/3AaLZV3HT9IcPoEo4/kRqI/PkN4GvzcSLaNoLW6ef+zXy5PXrxYqO9xTnooO+IHEQlfwkA0cO0DnTKbCGRu4/JFGHrn/j9/WpWSTYfFvycc/NqCGpiiNZlL8K7ZuePrg7dtN7h3mirQHstbYRZvgQFYU24gbzJUEpcvKg7FQKOd4Y5fd1D/GypEGhiZ0QgEPkx85h2PaJOaW9MME/eL09HhOM5mRtHnOuJIyda0yyNrxeEK9cS+Bg36fP7v82efPwdOVajro92sOgnxEfQ6gwGyiNG1bQhkasWgr4PIT9Mw4NDZWfeRWjrGRvSEL16jyyq6R+xXKy6bx4myKYXsEiCur6DqBSVWgXiJpSc3rK4JjdfNoXIhnKOFNNHoheOBMY+UnAbK8EKvBaUtHeo47+jDIJctI8qhyB3hlKr+EtWrnNPS5wQ7cooMCc75QkIQQXe1RaZKLlG5n8Ly0Drsq5CSGf71ClJYhz7nL06CcY8qN3fbg+AickvQ/Kw3XDkSTDIdcGof9Pf7sr2784X9XFeys5VMtCl3GkH22+jhqzEOTOs9ZJlbKSez/4Uzj/CK2UTCdy//V0hloqDTdlZTxsRddMllWWUuyB8c5oSPwdgo4RqUhR0+2tzyRCvITI+MdOuNLdLhLp2KnfQjtzJSsudMOTsVLeGVzkYqJ96VLd3awVD1uTMocPVduLzOF4BvE/IJxwsUSc7x9zVhEgxXNb6mBHIOQSJof34fnBZGKlz+dhrOSi/DN8tb6fNnaNVf0duu87GlbvSa/WbA8exRDv9vr9/pieQ6vPENwl2icL1C3jMT3j/XnjvU9bV2oP+XFpImMpzu/U+aoAoYQ9lmzS+dizWyqJHPKxDjPs7PZFTo6s3ld83B8neDNk8px+kqRXmPu1p9K2ng/59tFp8OxU+94cGm6LxHS7AatYu2f6N2TNw1TP4XHPg91gpy3pnraBjYHr6SoR3UiJoSSbIAYJ4YRyPYpL18u3Dhs+OUprhhkGZX+XtlRq6iPB6fDF1xEzcNOERhdWLzlUwpvI0oTIhNqM4zNRI56XAW6ElEplxyuVuxahQa3OuMwm0WJU/OedF0vwuL5f45MXf8J9WIRpw==
sidebar_class_name: "patch api-method"
info_path: docs/api/organization
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update an organization"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/organization/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates information for an organization.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"description":"The ID of the organization to update.","schema":{"type":"string"}},{"name":"metadata_include","in":"query","description":"Comma-separated list of metadata properties to include in the response. Available values [schemas, tags].","example":"schemas,tags","schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the organization.\n\n> ℹ️ **Note:** Changing the organization's name **does not change the slug**, \n as doing so could break connections with existing applications and services.\n","type":"string","example":"Crypto Inc."},"status":{"description":"The status of the organization.","type":"string","enum":["active","inactive"],"example":"active"}},"title":"organization_write"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"An object representing the organization.","content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","status"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the organization.","example":9823413412},"name":{"type":"string","maxLength":60,"description":"The organization name.","example":"Crypto Inc."},"slug":{"maxLength":70,"type":"string","description":"The organization slug.","example":"crypto-inc"},"status":{"type":"string","description":"The status of the organization.","enum":["active","inactive"],"example":"active"},"metadata":{"type":"object","description":"The metadata loaded via the metadata catalog API.","example":{"key":"value"},"properties":{"key":{"type":"string","description":"The key of the metadata.","example":"key"},"value":{"type":"string","description":"The value of the metadata.","example":null},"additional_properties":{"type":"object","description":"Additional metadata properties, including schemas and tags.","properties":{"schemas":{"type":"array","description":"The JSON schemas of the metadata.","items":{"type":"object"}},"tags":{"type":"array","description":"Tags associated with the metadata.","items":{"type":"object","properties":{"key":{"type":"string","example":"key"},"value":{"type":"string","example":"value"}}}}}}},"title":"MetadataComponent"}},"title":"organization"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>