Skip to navigation
Management APIAccounts

Update an Account

View as Markdown

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.

Authentication

AuthorizationBearer
This authentication type can be used to directly call the service.
OR
X-API-KEYstring
This authentication type is supported by using the provided API key for the merchant account.

Path parameters

idlongRequired>=1
Identifier of the account to update.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"3-100 characters
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.
namestringRequired1-50 characters
Legal or trading name of the account. Maximum 50 characters.
einstringOptional<=12 characters
Optional Employer Identification Number. Maximum 12 characters.
phonestringOptional<=16 characters
Optional account phone number. Maximum 16 characters.
stateIncorporatedstringOptionalformat: "^[A-Za-z]{2}$"=2 characters

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

Response

OK
accountIdlong
Identifier of the account.
createdAtstringformat: "date-time"
When the account was created. Stored to the minute.
emailstring
Primary email for the account.
namestring
Name of the account.
$schemastringOptionalRead-onlyformat: "uri"
A URL to the JSON Schema for this object.
contactobjectOptional
The account's first contact. Returned by create only.
einstringOptional
Employer Identification Number, when one was supplied.
phonestringOptional
Account phone number, when one was supplied.
stateIncorporatedstringOptional
State of incorporation, when one was supplied.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error