Users and profile (account)

Add people at a business who can log in to see and manage its reviews.

Add people at a business who can log in to see and manage its reviews.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
POSTAdd an account userCreate a new user under the authenticated account with a role (admin / location_assign / basic), optional per-store assignments and default reports (activity, review-response, insight).
POSTEdit an account userUpdate an existing account user's name/title, role, store assignments, optional password and deactivation date.
POSTGet one account userReturns a single user's profile, derived user_type, role, assigned locations (as {value,label} options) and assigned accounts.
DELETERemove a userSoft-delete a user (and their person), anonymises the email, revokes any live tokens (SOC 2 CC6.2) and removes the user's email reports.
POSTUpdate your own profileUpdate the currently authenticated user's own profile — name, phone, title, email and optional password.