Skip to main content
PATCH
Update a user

Authorizations

x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Path Parameters

organizationId
string
required

The ID of the organization

Body

application/json

The user to update

email
string<email>
required

The email of the user

Maximum string length: 255
Example:

"example@example.com"

isActive
boolean

Whether the user is active

Example:

true

name
string
Minimum string length: 1
Pattern: ^[\p{L}\p{M}\s'\d-]+$
role
enum<string>

The role of the user in the organization

Available options:
owner,
manager,
member
Example:

"member"

teams
string[]

The list of teams the user is a member of

Example:

Response

200 - application/json

User updated successfully.

id
string

The ID of the user

createdAt
string

The date and time the user was created

Example:

"2021-01-01T00:00:00.000Z"

updatedAt
string

The date and time the user was last updated

Example:

"2021-01-01T00:00:00.000Z"

lastLoginAt
string

The date and time the user last logged in

Example:

"2021-01-01T00:00:00.000Z"

isActive
boolean

Whether the user is active

Example:

true

name
string

The name of the user

Minimum string length: 1
Pattern: ^[\p{L}\p{M}\s'\d-]+$
Example:

"John Doe"

email
string<email>

The email of the user

Maximum string length: 255
Example:

"example@example.com"

role
enum<string>

The role of the user in the organization

Available options:
owner,
manager,
member
Example:

"member"

teams
string[]

The list of teams the user is a member of

Example: