Skip to main content
PATCH
Update client user

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

clientPublicId
string<uuid>
obrigatório
userPublicId
string<uuid>
obrigatório

Corpo

application/json

Body for updating a user inside a client workspace.

role
enum<string>
obrigatório

New role assigned to the user inside the client workspace.

Opções disponíveis:
admin,
member,
editor,
viewer
name
string

New full name of the user.

Maximum string length: 150
Exemplo:

"Ada Lovelace"

Resposta

OK

createdAt
string<date-time>
creditsBalance
number
creditsUsedThisPeriod
number
currentPeriodEnd
string<date-time>
currentPeriodStart
string<date-time>
extraCreditsBalance
number
nextCreditRenewalAt
string<date-time>
pendingInvitations
object[]
pendingPlan
object
plan
object
publicId
string<uuid>
seatsLimit
integer<int32>
subscriptionStatus
enum<string>
Opções disponíveis:
active,
past_due,
canceled,
trialing,
pending_onboarding,
suspended
unlimitedCredits
boolean
users
object[]
usersCount
integer<int32>
workspaceName
string