---
id: account-update
title: "Update an account"
description: "Updates a specific account."
sidebar_label: "Update an account"
hide_title: true
hide_table_of_contents: true
api: eJzdWF1uI8cRvkqhX2ILI4rSSmuAQRLQyiZeO7EXu1zEiChIxekip62Z7tnuGlE0wTe/5zrJdXKBXCGo7qE4pKifBE4CRA+jYU91/Xz1271UmkLuTc3GWTVQH2uNTAEQQk25mZocMM9dY7mnMsU4C2pwoYZpSV1mytXkUTa/1WqgWtpBE9moTNXosSImL/uWyoiMGrlQmbJYkRooo1WmQl5QhWqwVLyo46plmpFXq0x5+tQYT1oN2DeU7Sg8Kgje/hbcFLigrq50h1Vdkhocn7w6XV0mPhT4S6cXIih3lsmyvGJdlyaPVhz9EITt8qFGbvID5ay6+lwkGzIVGLkJAkftBRA2FGRrMvGeRWBv7EztM0Eod40Y27H9Nfz9p7/9469/gYODbx3T4OAAzgu0M2NnXdrwi5BYHBxoRwGsY8iFjiJVKJvZwUEGYwsYQDvZHRzkrik1TDzhDeTOWspFowBzwwXQnQkshB10AqDVEMjfmpxCb2y7OKtzv6jZwTfOzsRvLSh7zCfbVIIe5mxuBT9j29fLfdgkRk+5eM1ptcoUG26XIt3V3BuWL/ItUN54w4sYixNCT37YcKEGF5cpQkLtbEi+O+mfyr9tdYYWUhyAp9pTIMs7nhC9fpbQinmxjq+yEdycn6E1P0ZuVylvHgk8o/fk0i62QwiLwFQdzo0maKz51MRcmjr/dDJljwZ2hXd/IDsTSF/39/my5RmDtfdk9IjJT0v44oEEcU8Hoy3DhOGTpqk8anB402qwi/bzgG7Xou5+4AIZ3NwG4MKEx6D9N7NG9CiJSf8r+QPy6brdeA23WDYEJoCz5QI8ceMtaTB2bO/TAtjB9e/fjOCoZXK0NHr1m1C4+VXL6FdSo68jzuvSNLbR+AJvCSZEFoKb8mFL/0swDDlaKVgTgkAMtwYh94QsEELqJLulZp3v95ZfIe/DbOp8JV+UMDlkE7PJNmWJE+HzWEMRwsBY1YAM88LkRRc6mGPYMiITRa+F7TWYqdi7oTUBApuyhKRyD74TfGtXNyVyBBi6+I7tiwDexeOkf/L6sH92eHw2Oj4ZvDodnL3u9fv9PwtCFTFq5L0F56Hpa2ooHWrS0RvcXc+RsXQzGL57uxW+S3VDCzVQMZBE7nZFih9f0glvaLEO1bXM7TQVTquslfMilim2n2IqvltlCrU2sg/Lq23tn8ZteL9tA9NmfwbG5mWjY9ONpT+1URmmRIltSS1FRyh6j4u9dn394btv71nuMc8wVXvUj10yTnLPycBZAAzB5SbGapwLXijkhf5/uVs3lG2Epb9Nw/9jq9S5q2pnpf/uGQfaQeD0++8fNvfz0pBlIO+d7ySlbkgKn7G3WBpJ2LphSfjKhCA+3Yy4P1vvTxX73GkpV1Ef6XwUAs7oYbPvUD/fo74ajd6tO0LuND0cZO4H/7yLx2fUm/UyOO335XEsj1fyOP18K5FO+/2VgKBfkJpDqDAvjKVDT6ilIreyol6xaeTINHPe/CjFUXQjf0sepmjKxu8MEBPUV+2ML4GUYHuBEhNvaJpB0VRoN5p0qNaplZQTdms0xupL1PA+CR0rWfhoseEiqqzHahucLnWqzMmjzyu5KTCaGE0ZACeu4Y1a23KkOLRQxGZVYSmdkDREdC2jSc09hXQ3gtdZdbYvQ95aJi9atH5IiLQJghYaS3c15bGvhdDQ/1lCbFndhsCZJMRZ/0Qer7bdffa/ywXTOuoqEV0lyP5rWXEfJx+Sjm+EJuXHh3R4hI8Wb9HEOexBmuzd/h9NmOFW7CaTXJ433pPuwbuSMBCwXwDO0FiQ0c33Ni2oIi6cTlcbeRGvPeSAorbGODmuRXvSVUjjSzVQBXMdBkdHWJueDCF1iSyp2stdpeRMuj6yfpA8SeHdPbjeAyGM1hcpsRpGIpW1L79bD8Jf/2kU+6Lk3/vNjcibzRjX3st0z2ObY0ln8jZ26oReLEqoH/f6vb7a9Nz1NZEMgy5whbbDP900SdVYt+YdJ3auaJ67lkoQMN3xUV2isSIx4rtsPXGhNkIGJp6TChdYPiyXEwz00ZerlSx/asjL/cCljCLepHPCxVJpE+Rdq8EUy7B7aujq+tn7tnB9Do9eTu3VeD2LWZnE2jlIqaydq41Wq8tVpgpCTT7qlD6cJ8mHI9m+2fig2K6y9Y5hnlPNT9JedoL63XB0/pVEUntzVsWKpjzOpUrjPGnpIhQxQOPaUpVoZ01MV5WYStzhdtjuhGk0ay8Oy2WiGLkbsqvVPSwsvwWZ1eqf+/oy0w==
sidebar_class_name: "patch api-method"
info_path: docs/api/account
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 account"}
>
</Heading>

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



Updates a specific account.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The ID of the account.","example":1234}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"204":{"description":"An object representing the account.","content":{"application/json":{"schema":{"type":"object","required":["id","name","slug","organization_id","status"],"properties":{"id":{"type":"integer","description":"A system-wide unique ID for the account.","example":1234},"name":{"type":"string","maxLength":60,"description":"The account name.","example":"Crypto Kong"},"slug":{"type":"string","maxLength":70,"description":"An organization-wide unique slug for the account.","example":"crypto-kong"},"organization_id":{"type":"integer","description":"The ID of the organization that owns this account.","example":123},"status":{"type":"string","enum":["active","inactive","deleted"],"description":"The status of the account. The `deleted` value is only returned in\nresponses to `GET /account/{id}?show_deleted=true` for accounts\nthat have been soft-deleted; it cannot be set via create or update.\n","example":"active"},"deleted_at":{"type":"string","format":"date-time","nullable":true,"description":"The timestamp at which the account was soft-deleted, or `null` if\nthe account is still active. Only populated in responses to\n`GET /account/{id}?show_deleted=true`.\n","example":"2026-05-15T12:34:56.000Z"},"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":"account"}}}},"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":"Internal server error due to an unexpected issue.","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>


      