Update User E2E Key in Room

Prev Next
Post
Deprecated
/api/v1/e2e.updateGroupKey

This endpoint has been deprecated and is scheduled for removal in the 8.0.0 release.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "uid": "d26x6zSkaPSe5gCyy",
  "rid": "9R1V4t3_k3Y",
  "key": "M4-Ubd4T3d-k39"
}
object
uid
string Required

The user ID whose key you want to update.

rid
string Required

The room ID.

key
string Required

The updated key.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Invalid Params
{
  "success": false,
  "error": "must have required property 'rid' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string