Add an account user

post

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

Add a person at a business with access to chosen locations. Use this to give a manager or staff member a login. The user is created and emailed a set-password link. With send_default_reports: 1 they're also subscribed to the monthly activity report, the weekly review responses report and the monthly insight report; the response lists which reports were turned on.

Prerequisites: an Account token. To limit the user to some locations: the location ids (store_ids).

Authentication: Account token. The new user is created at the account of the user behind the token; any other token (for example a Partner token) gets 403. Every id in store_ids must be a location inside your account, otherwise 422. Only an Owner or Admin User of the account can add users; anyone else gets 403.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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 >.

title

string | null

Defaults to Manager

Job title. Up to 50 characters. Can't contain < or >.

string

required

A valid email address, not already used by another user. The domain must accept mail (it's checked with a DNS lookup), so test domains like example.com are rejected with 422.

password

string

required

length between 8 and 100

8 to 100 characters, with upper- and lower-case letters, a number and a symbol. No quotes, backslashes or spaces.

user_type

string

enum

required

Defaults to location_assign

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

Allowed:

store_ids

array of integers

Defaults to 3007

The locations the user can access. 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 1

1 subscribes the user to the monthly activity report, the weekly review responses report and the monthly insight report. 0 or left out: no reports.

Allowed:

inactive_at

string | null

Defaults to null

Date and time to deactivate the user, as YYYY-MM-DD HH:MM:SS. Leave it out or send null for no deactivation date.

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 created.

401The token is missing, expired or invalid.

403The token isn't an Account token, or its user isn't an Owner or Admin User.

422A field is missing or invalid, the email is taken or rejected, or a location is outside your account.

500Unexpected server error.