Skip to main content
PUT
/
users
/
{id}
Update a user
curl --request PUT \
  --url https://core.ravenna.ai/api/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "firstName": "<string>",
  "lastName": "<string>",
  "workspaceRole": "GUEST",
  "organizationRole": "GUEST",
  "email": "<string>",
  "image": {
    "base64": "<string>",
    "fileName": "<string>"
  }
}'
{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "image": "<string>",
  "emailVerified": "<string>",
  "defaultWorkspaceId": "<string>",
  "isGuestCreated": true,
  "isBot": true,
  "createdAt": "<string>",
  "auth0Id": "<string>",
  "updatedAt": "<string>",
  "slackUsers": [
    {
      "id": "<string>",
      "slackUserId": "<string>",
      "slackTeamId": "<string>",
      "slackAppId": "<string>",
      "slackImageUrl": "<string>",
      "slackRealName": "<string>",
      "slackDisplayName": "<string>",
      "isBot": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "slackApp": {
        "appId": "<string>"
      }
    }
  ]
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Body

application/json
firstName
string | null
lastName
string | null
workspaceRole
enum<string> | null
Available options:
GUEST,
MEMBER,
ADMIN,
BOT
organizationRole
enum<string> | null
Available options:
GUEST,
MEMBER,
ADMIN,
BOT
email
string
image
object

Response

Successful response

id
string
required
firstName
string | null
required
lastName
string | null
required
email
string
required
image
string | null
required
emailVerified
string | null
required
defaultWorkspaceId
string | null
required
isGuestCreated
boolean
required
isBot
boolean
required
createdAt
string
required
auth0Id
string | null
required
updatedAt
string
required
slackUsers
object[]
required
I