Edit a partner user

post

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

Change a user's details, role, or access scope. Use this when responsibilities change. The user is updated; access changes take effect on their next request. Every call replaces the user's name, title, deactivation date and account list with what you send, so send the current values for anything you're not changing (get them from Get one user).

Prerequisites: a Partner token, and the user's id from List users.

Authentication: Partner token. The user must be at the same partner as the user behind the token, otherwise 403 Permission denied.; every id in account must be an account inside your partner's tree, 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.

user_type

string

enum

required

Defaults to assign_brand

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

Allowed:

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.

account

array of integers

Defaults to 5994

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

account

assign_all_accounts

integer

enum

Defaults to 1

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

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. A date that has already passed deactivates the user straight away and revokes all of their tokens, including the API key. 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 user isn't at your partner, or you're not allowed to manage them (see Authentication).

422A field is missing or invalid, the user doesn't exist, or an account is outside your tree.

500Unexpected server error.