Create location

Create a new store location under an account in one transaction: a bundle_id=2 location-account record + its company options, the store row, and a store_options row (inheriting who_will_pay). If the account has a most-recent company_plan, the store is auto-attached to that plan and blank store_review_site rows are seeded. Rejects duplicates (same name+address+zip+city under bundle_id=2). Logs an audit event and emails a location-added notification.

Auth: Partner — authentication, under the partner/ group. The target account is account_id: must exists in company with bundle_id=3 and not deleted, AND pass an ownership check (must be an account inside the caller's partner tree).

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
namestringrequiredmax 255; NameNoAngleBrackets (no </>)
storeidstringoptionalmax 100; NameNoAngleBrackets
client_location_idstringoptionalmax 100; NameNoAngleBrackets
addressstringrequiredmax 255; NameNoAngleBrackets
city_idintrequiredmust exist:city,id
postal_codestringrequiredmin 3, max 12; NameNoAngleBrackets
site_urlstringoptionalmust be a valid URL
company_phonestringoptionalmin 9, max 15 digits — primary business phone
phonestringoptionalmin 9, max 15 digits — secondary line
account_idintrequiredparent account company id; bundle_id=3, not deleted, + an ownership check

Response{ data. } envelope.

  • status (string) — success.
  • message (string) — Location has been created successfully!.

A duplicate location currently comes back as 500 with { status: "error", message: "This location is already registered!" }.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
integer
string
string
string
string
integer
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