Save Auto-Translate Settings

Prev Next
Post
/api/v1/autotranslate.saveSettings

Saves autotranslate settings for a room.

Changelog

Version Description
1.3.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "roomId": "7aDSXtjMA3KPLxLjt",
  "field": "autoTranslate",
  "value": true,
  "defaultLanguage": "en"
}
object
roomId
string Required

The room's id to apply setting.

field
string Required

The setting to apply to user's subscription.

value
boolean Required

Boolean if the setting is autoTranslate and a string (the language) if the setting is autoTranslateLanguage.

defaultLanguage
string

The default language.

Responses
200

OK

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

Unauthorized

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