API Reference
  1. Spartera API Documentation
  2. Users

Update an existing user by ID

patch
https://api.spartera.com/companies//users/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 255
^[a-zA-Z0-9_-]+$

Unique identifier for the Company

string
required
length between 1 and 255
^[a-zA-Z0-9_-]+$

Unique identifier for the User

Body Params

Update schema for modifying User

string

References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.

int64

User's role for RBAC - single source of truth

int64

User's job function/title

string
enum

Required. One of: ACTIVE, PENDING, INACTIVE, BANNED.

Allowed:
string

Optional. Must be unique.

string

Optional.

boolean

Whether user has opted out of marketing communications. Default false = opted in per ToS.

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?