Overview / System / Change role or scope

Change role or scope

patch https://api.flactrum.com/v1/users/{user}

Required scope	users.write
Success status	200
Returns	One BrandUser object

Parameters

Name	In	Type	Description
user *	path	string	ULID of the record.

Request body

Field	Type	Description
name *	string	—
email *	string	Unique within this brand. Someone with an account in another brand can still be invited here.
role_id *	string	—
scope *	string	What the membership can see. scoped: the branches in branch_ids plus every branch in regions.
branch_id	string\|null	Required when scope is branch.
region	string\|null	Required when scope is region.
branch_ids	array	With scope scoped.
regions	array	With scope scoped.
employee_id	string\|null	On invite: link the new account to this employee record (one without an account).
two_factor_required	boolean	Head office admin only; ignored for anyone else.

Response fields

Field	Type	Description
id	string	Membership id — not the user id.
user_id	string	—
name	string\|null	—
email	string\|null	—
role_id	string	—
role	string\|null	Role slug.
branch_id	string\|null	Set when the membership is scoped to one branch.
region	string\|null	Set when scoped to a region.
branch_ids	array	Every branch the membership covers directly.
regions	array	Every region the membership covers.
scope	string	Derived from the branches and regions; the same value the invite input takes. scoped means more than one branch or region.
two_factor_required	boolean	This person must use two-factor authentication.
two_factor_enabled	boolean	Whether they have set it up.
invitation_url	string	Only in the response to an invite or resend, and only to the caller: the one-time acceptance link, so it can be passed on by hand if the e-mail does not arrive. Never stored or listed.
status	string	—
joined_at	string\|null	—

Examples

No recorded example yet.