Edit an account user

post

https://production-api.shoutaboutus.com/api/v1/user/edit

Change a user's details or locations. Use this when roles change. The user is updated. Every call replaces the user's name, title, deactivation date and location list with what you send, so send the current values for anything you're not changing (get them from Get one account user).

Prerequisites: an Account token, and the user's id from List users.

Authentication: Account token. The user must be at the same account as the user behind the token, and can't be you; otherwise, or with any other token (for example a Partner token), 403. Every id in store_ids must be a location inside your account, otherwise 422. Only an Owner or Admin User can edit users, and you can't edit the Owner or someone who ranks above you; otherwise 403.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user

integer

required

Defaults to 12

The id of the user to edit.

first_name

string

required

length ≤ 255

Defaults to Jane

Up to 255 characters. Can't contain < or >.

last_name

string | null

Defaults to Smith

Up to 255 characters. Can't contain < or >. Left out, it's cleared.

title

string | null

Defaults to Manager

Job title. Up to 50 characters. Can't contain < or >. Left out, it's cleared.

password

string | null

A new password: 8 to 100 characters, with upper- and lower-case letters, a number and a symbol. No quotes, backslashes or spaces. Leave it out or empty to keep the current password. A new password signs the user out everywhere: their tokens are revoked, except the API key from the dashboard's API Keys page.

user_type

string

enum

required

Defaults to location_assign

The user's role: admin, location_assign (only the locations in store_ids) or basic. admin removes every location assignment.

Allowed:

store_ids

array of integers

Defaults to 3007

The locations the user can access. Replaces the current list. Each must be inside your account. Required when user_type is location_assign, or basic with assign_all_accounts: 0.

store_ids

assign_all_accounts

integer

enum

Defaults to 1

Required when user_type is basic. 1: all locations. 0: only the locations in store_ids.

Allowed:

send_default_reports

integer | null

enum

Defaults to 0

0 or 1. Not used when editing; the user's report subscriptions don't change.

Allowed:

inactive_at

string | null

Defaults to null

Date and time to deactivate the user, as YYYY-MM-DD HH:MM:SS. Left out or null, any deactivation date is cleared.

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 user was updated.

401The token is missing, expired or invalid.

403The token isn't an Account token, the user isn't at your account, the user is you, or you're not allowed to manage them (see Authentication).

422A field is missing or invalid, or a location is outside your account.

500Unexpected server error.