accounts

Update an Account

Replaces the profile fields of the account identified by id in the path. Requires a service credential with the update:accounts scope.

Replacement semantics

The body carries the same fields as Create an Account, without contact, and is the complete desired state. name and email are required. An omitted optional field (phone, ein, stateIncorporated) is cleared, not preserved. Creation time, disabled state, SST enrollment and contacts are never modified; a contact object is rejected with 422.

Sending the same body twice leaves the account unchanged, so this call is safe to retry. The response is the account as stored after the write.

put/mgmt/accounts/{id}

Request

  • Base URL: https://api.v3.taxcloud.com
  • URL: https://api.v3.taxcloud.com/mgmt/accounts/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Identifier of the account to update.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

einstring

Optional Employer Identification Number. Maximum 12 characters.

emailstring email required

Primary email for the account. Must be a bare address with no display name. On create, also used for the account's first contact unless a contact object overrides it.

namestring required

Legal or trading name of the account. Maximum 50 characters.

phonestring

Optional account phone number. Maximum 16 characters.

stateIncorporatedstring

Optional two-letter state code where the business is incorporated.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

accountIdinteger required

Identifier of the account.

createdAtstring date-time required

When the account was created. Stored to the minute.

einstring

Employer Identification Number, when one was supplied.

emailstring required

Primary email for the account.

namestring required

Name of the account.

phonestring

Account phone number, when one was supplied.

stateIncorporatedstring

State of incorporation, when one was supplied.

Changes

No recorded changes to this operation across all 1 revision of this API.