Edit account

Update an existing account company row plus its owner user/person and account company_options. Field names passed in override_locations are cascaded down to the account's child stores (only who_will_pay is actually mirrored onto each store's company_options).

Auth: Partner — authentication under partner/account. Target resolved by path id. Controller 404s if the row is missing or not bundle_id=3, then walks getParentCompany(brand,'partner') and calls canManageBrand (super-admin, or the caller's partner == the account's partner) else 403. owner_email uniqueness ignores the account's current owner user.

Rate limit: No rate limit.

Request

  • Body (JSON):
FieldTypeRequiredNotes
namestring (max 100)yesNo angle brackets.
websitestring (url)no
billing_idstring (max 100)noNo angle brackets.
client_account_idstring (max 100)noNo angle brackets.
phonestring (9–15)no
addressstring (max 255)yesNo angle brackets.
city_idintegeryesMust be an existing city.
companyindustry_idintegernoMust be an existing industry (active industries only). Optional industry tag; a partner-level industry, when set, cascades and overrides this on save.
postal_codestring (3–12)yesNo angle brackets.
first_namestring (max 100)yesOwner first name.
last_namestring (max 100)noOwner last name.
owner_emailemail (rfc,dns)yesUnique, ignoring this account's current owner.
owner_phonestring (9–15)no
override_locationsarraynoCascade field list.
override_locations.*string in:plan_idnoOnly plan_id is an accepted value.

Response{ data. } envelope.

  • status (string) — success.
  • message (string) — Account has been updated successfully!.
  • accountId.label (string) — account name.
  • accountId.value (integer) — account company id.
  • stores_updated (integer) — count of child stores touched by the cascade.
  • overrides_applied (string[]) — the override field names received.

Path params

ParameterTypeRequiredNotes
brandIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
string
string
string
string
string
integer
integer
string
string
string
string
string
override_locations
array of strings
override_locations
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json