Sign in

v3

latestOpenAPI 3.0.32026-07-31135300306.1 KB
accounts

Update an existing account

Updates an existing account by ID or external ID. Only provided fields are modified.

Rate limit: 60 requests per minute

patch/accounts/{id}

Path parameters

idstring required

The ID or external ID of the account to update.

Request body

account_typestring

The type of the account. Can only be changed to "customer" or "partner".

domainsstring[]

Domains of the account. Must specify one domain as primary.

is_disabledboolean

Whether the account is disabled.

logo_urlstring

Logo URL of the account.

namestring

The name of the account.

owner_idstring

The ID of the owner of the account. If empty string is passed in, the owner will be removed.

primary_domainstring

Must be in the list of domains. If there are any domains, there must be exactly one primary domain.

subaccount_idsstring[]

An array of account IDs to be added as subaccounts to this account.

tagsstring[]

An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.

Response

request_idstring

The request ID for tracking.