API Reference

Add a partner user

post
https://production-api.shoutaboutus.com/api/v1/users/partner/add

Add a person at your partner with a role and access to chosen accounts or locations. Use this to onboard a team member. The user is created and emailed a set-password link. With send_default_reports: 1 they're also subscribed to the monthly activity report and the weekly review responses report.

Prerequisites: a Partner token. To limit the user to some accounts: the account ids, from List accounts.

Authentication: Partner token. The new user is created at the partner of the user behind the token; every id in account must be an account inside your partner's tree, otherwise 422. Only an Owner or Admin User can add users; anyone else gets 403.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Defaults to assign_brand

The user's role: admin, assign_brand (only the accounts in account) or basic.

Allowed:
string
required
length ≤ 255
Defaults to Jane

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

string | null
Defaults to Smith

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

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.

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.

account
array of integers
Defaults to 5994

The accounts the user can access. Each must be inside your tree. Required when user_type is assign_brand, or basic with assign_all_accounts: 0.

account
integer
enum
Defaults to 1

Required when user_type is basic. 1: all accounts. 0: only the accounts in account.

Allowed:
integer | null
enum
Defaults to 1

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

Allowed:
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

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?