Activepieces Management Octri Preview
POST/v1/users/{id}

Update a user

Updates a user's external identifier, platform role, or status. Supply any fields you want to change; platformRole must be ADMIN, MEMBER, or OPERATOR, and status must be ACTIVE or INACTIVE.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
idstringrequired
The user's unique identifier, consisting of exactly 21 alphanumeric characters.

User fields to update; all fields are optional.

externalIdstringoptional
An external identifier to associate with the user.
platformRolestringoptional
The user's platform role: ADMIN, MEMBER, or OPERATOR.
Allowed:ADMINMEMBEROPERATOR
statusstringoptional
The user's status: ACTIVE or INACTIVE.
Allowed:ACTIVEINACTIVE

1 status code
200Returns the updated user object, including their identifier, email, name, status, platform role, and timestamps.
createdstringrequired
emailstringrequired
externalIdstringoptional
firstNamestringrequired
idstringrequired
imageUrlstringoptional
lastActiveDatestringoptional
lastNamestringrequired
platformIdstringoptional
platformRolestringrequired
Allowed:ADMINMEMBEROPERATOR
statusstringrequired
Allowed:ACTIVEINACTIVE
updatedstringrequired

Error handling

The id path parameter must be exactly 21 alphanumeric characters and identify a user. If provided, platformRole must be ADMIN, MEMBER, or OPERATOR, and status must be ACTIVE or INACTIVE.