Create an account

post

https://production-api.shoutaboutus.com/api/v1/partner/account/create

Create a new account under your partner, with its owner. The owner gets a set-password welcome email automatically. Add with_location=1 to also create its first location in the same call; to place the account under one of your sub-partners instead of directly under you, pass parent_company_id. Returns the new account's id (accountId.value).

Prerequisites: a plan_id set up for your partner, a city_id and an industry id (companyindustry_id).

Authentication: Partner token. The account is created under your partner, or under parent_company_id, which must be inside your account tree; plan_id must be one of your partner's plans. Otherwise 422.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 already belong to a user. The domain must accept mail (it's checked with a DNS lookup), so test domains like example.com are rejected with 422.

owner_phone

string

Defaults to 9876543210

The owner's phone. 9 to 15 characters.

password

string

required

The owner's starting password. 8 to 100 characters, with upper- and lowercase letters, a number and a symbol; no quotes, backslashes or spaces.

plan_id

integer

required

Defaults to 36

The plan to assign. Must be one of the plans set up for your partner.

parent_company_id

integer

Defaults to 6000

Where to place the account: one of your sub-partners or another company in your account tree. Leave it out to create the account directly under your partner.

with_location

integer

enum

Defaults to 0

1 to also create the account's first location, on the same plan, from the account's name, address, phone and website. 0 or left out: no location.

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 created.

401The token is missing, expired or invalid.

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

500Unexpected server error.