Set Room E2E Key

Prev Next
Post
/api/v1/e2e.setRoomKeyID
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example
{
  "rid": "wCiXndNp5NqNY3uCc",
  "keyID": "my-UniQu3_ke4_Id"
}
object
rid
string Required

The room ID.

keyID
string Required

The key that you want to set for the room. Enter a unique string.

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"
}
E2E Key Exists
{
  "success": false,
  "error": "E2E Key ID already exists [error-room-e2e-key-already-exists]",
  "errorType": "error-room-e2e-key-already-exists",
  "details": {
    "method": "e2e.setRoomKeyID"
  }
}
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