Skip to main content
PATCH
Update a session

Authorizations

Authorization
string
header
required

Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.

Body

application/json
_id
string
Example:

"507f1f77bcf86cd799439011"

emailNormal
string<email>
Example:

"user@example.com"

invite
string<uri>
Example:

"https://example.com/path/to/object"

name
string
password
string
preferences
object
queue
any

Shape not inferred — the sampled response had no entries

status
object
territory
object
username
string<email>
Example:

"user@example.com"

orderQueue
any

Shape not inferred — the sampled response had no entries

shareQueue
string[]
id
string
Example:

"507f1f77bcf86cd799439011"

flags
any

Shape not inferred — the sampled response had no entries

twofactorVerified
boolean
permissions
any

Shape not inferred — the sampled response had no entries

groups
object[]
roles
string[]
studios
any

Shape not inferred — the sampled response had no entries

hasEnforced2fa
boolean

Response

OK

_id
string
Example:

"507f1f77bcf86cd799439011"

emailNormal
string<email>
Example:

"user@example.com"

invite
string<uri>
Example:

"https://example.com/path/to/object"

name
string
password
string
preferences
object
queue
any

Shape not inferred — the sampled response had no entries

status
object
territory
object
username
string<email>
Example:

"user@example.com"

orderQueue
any

Shape not inferred — the sampled response had no entries

shareQueue
string[]
id
string
Example:

"507f1f77bcf86cd799439011"

flags
any

Shape not inferred — the sampled response had no entries

twofactorVerified
boolean
permissions
any

Shape not inferred — the sampled response had no entries

groups
object[]
roles
string[]
studios
any

Shape not inferred — the sampled response had no entries

hasEnforced2fa
boolean