Edit an account

post

https://production-api.shoutaboutus.com/api/v1/partner/account/{brandId}/update

Change an account's business details or owner information. This replaces the record, so send every field, not just what changed: an optional field you leave out is cleared. The plan isn't changed here; use Assign or change an account's plan.

Prerequisites: the account's id (brandId). Get one account gives you the current values to start from.

Authentication: Partner or Account token (an Account token reaches only its own account). The account must be inside your account tree (otherwise 404); an account that belongs to another partner returns 403.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

brandId

integer

required

Defaults to 6021

Required. The account's id.

Body Params

name

string

required

Defaults to Acme Brand

The account (business) name. Max 100 characters, no < or >.

website

string

Defaults to https://acmebrand.com

The business website. Must be a valid URL.

billing_id

string

Defaults to BILL-001

Your billing reference for the account. Max 100 characters, no < or >.

client_account_id

string

Defaults to ACC-001

Your own id for the account. Max 100 characters, no < or >.

phone

string

Defaults to 1234567890

The business phone. 9 to 15 characters.

address

string

required

Defaults to 1 George St

Street address. Max 255 characters, no < or >.

city_id

integer

required

Defaults to 3243

The city. Must be an existing city id.

companyindustry_id

integer

required

Defaults to 37

The industry. Must be an existing, active industry id.

postal_code

string

required

Defaults to 2000

Postal code. 3 to 12 characters, no < or >.

first_name

string

required

Defaults to Jane

The owner's first name. Max 100 characters.

last_name

string

Defaults to Smith

The owner's last name. Max 100 characters.

owner_email

string

required

The owner's email address. Must not belong to another user. The domain must accept mail (it's checked with a DNS lookup).

owner_phone

string

Defaults to 9876543210

The owner's phone. 9 to 15 characters.

override_locations

array of strings

Defaults to plan_id

Accepted for compatibility. The only allowed value is plan_id, and it doesn't change any location; it's counted in stores_updated and echoed in overrides_applied.

override_locations

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The account is updated.

401The token is missing, expired or invalid.

403The account belongs to another partner.

404Account not found.: the id is unknown, not an account, or outside your account tree.

422The request failed validation. The response names the fields.

500Unexpected server error.