Skip to main content
POST
/
api
/
users
/
{id}
"<any>"

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

​
id
number
required

Body

application/json
​
firstName
string
required

First name of the user

Example:

"John"

​
lastName
string
required

Last name of the user

Example:

"Doe"

​
email
string
required

Email address of the user

Example:

"[email protected]"

​
roleId
number
required

Role ID assigned to the user

Example:

2

Response

200 - application/json

The user has been edited successfully.

The response is of type any.