post
https://production-api.shoutaboutus.com/api/v1/users/partner/add
Create a new user under the authenticated partner company, sets their role (admin / assign_brand / basic), optionally assigns account access and default reports, and emails first-login credentials via the white-label-aware welcome email. Side effects: creates User + Person (+ UserBrand rows), sends a welcome email, writes a USER_CREATED audit event.
Auth
- Partner — collection bearer token. The endpoint creates the new user under the caller's company.
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
user_type | string | Required | admin, assign_brand, or basic. |
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. |
account | integer[] | Required if user_type=assign_brand, or basic with assign_all_accounts=0 | Account company ids under the caller (validated by an ownership check). |
assign_all_accounts | integer | Required if user_type=basic | 0 or 1. |
send_default_reports | integer | Optional | 0/1; when 1 subscribes default activity + review-response reports. |
inactive_at | string | Optional | Y-m-d H:i:s deactivation date. |
Behaviour
- Synchronous (DB transaction).
200on success. 422on validation failure.500on save failure (transaction rolled back).
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…