v21

latestOpenAPI 3.1.0MIT Licenseraw.githubusercontent.com2026-08-0317123232.1 KB

Accounts

Update an account

Update an account's attributes

patch/platform/api/v1/accounts/{account_id}

Request body

namestring

Name of the account

localestring

The locale of the account

domainstring

The domain of the account

support_emailstring

The support email of the account

status'active' | 'suspended'

The status of the account

limitsobject

The limits of the account

custom_attributesobject

The custom attributes of the account

Example request

{
  "name": "My Account",
  "locale": "en",
  "domain": "example.com",
  "support_email": "support@example.com",
  "status": "active",
  "limits": {},
  "custom_attributes": {}
}

Response

Success

idnumber

Account ID

namestring

Name of the account