post
https://production-api.shoutaboutus.com/api/v1/user/add
Create a new user under the authenticated account with a role (admin / location_assign / basic), optional per-store assignments and default reports (activity, review-response, insight). Emails first-login credentials via the white-label welcome email. Side effects: creates User + Person + Email + UserStore (+ Report) rows, sends a welcome email, writes a USER_CREATED audit event.
Auth
- Account admin — collection bearer token.
authorizerequires the caller's companybundle_idto be ACCOUNT, else403(This action is unauthorized.).
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
first_name | string | Required | ≤255 chars; no angle brackets. |
last_name | string | Optional | ≤255 chars. |
title | string | Optional | ≤50 chars. |
email | string | Required | Valid email; unique in users. |
password | string | Required | 8–100 chars, mixed case + number + special char, no spaces/quotes. |
user_type | string | Required | admin, location_assign, or basic. |
store_ids | integer[] | Required if user_type=location_assign, or basic with assign_all_accounts=0 | Store ids under the caller's account (an ownership check). |
assign_all_accounts | integer | Required if user_type=basic | 0/1. |
send_default_reports | integer | Optional | 0/1; 1 enables default reports (account companies only). |
inactive_at | string | Optional | Y-m-d H:i:s deactivation date. |
Behaviour
- Synchronous (DB transaction).
200returns per-reporterror/info/successarrays alongside the success message. 403when the caller is not an account company (authorize fails).422on validation failure;500on save failure (rolled back).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…