Edit account user
Overview
Update an existing account user — their name/title, role, store assignments, optional password, and deactivation date. You cannot edit your own user record. A password change revokes that user's live tokens and is audited. The user must belong to the caller's account company.
Prerequisites
- A bearer token in the
Authorizationheader.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
POST /api/v1/user/edit
Authentication
-
Requires a bearer token in the
Authorization: Bearer <bearer-token>header. -
Account admin — send an account bearer token.
-
Authorization checks three things:
- Your company must be an account (
bundle_id = BRAND). - The target user must be in that same company.
- The target must not be yourself — editing your own record returns
403.
- Your company must be an account (
Rate limit
- No rate limit.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
user | integer | Required | Id of the user to edit. |
first_name | string | Required | ≤255 chars; no angle brackets. |
last_name | string | Optional | ≤255 chars. |
title | string | Optional | ≤50 chars. |
password | string | Optional | 8–100 chars, complexity rules; blank leaves the password unchanged. |
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. |
assign_all_accounts | integer | Required if user_type=basic | 0/1. |
send_default_reports | integer | Optional | 0/1. |
inactive_at | string | Optional | Y-m-d H:i:s. |
{
"user": 12,
"first_name": "Jane",
"last_name": "Smith",
"title": "Manager",
"password": null,
"user_type": "location_assign",
"store_ids": [
12
],
"assign_all_accounts": 1,
"send_default_reports": 1,
"inactive_at": null
}How it works
- Synchronous (DB transaction).
200on success. 403when authorize fails (not an account / target not in company / editing self).422on validation failure;500on save failure (rolled back).
Response
200 OK · 200
200{
"data": {
"status": "success",
"response": "User information has been updated successfully"
}
}403 Unauthorized · 403
403{
"message": "This action is unauthorized."
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | Unauthorized |
422 | Returned on validation failure |
500 | Returned on save failure (rolled back) |
Example request
curl --request POST \
--url "https://production-api.shoutaboutus.com/api/v1/user/edit" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"user": 12, "first_name": "Jane", "last_name": "Smith", "title": "Manager", "password": null, "user_type": "location_assign", "store_ids": [12], "assign_all_accounts": 1, "send_default_reports": 1, "inactive_at": null}'Updated 11 days ago
Did this page help you?
