Returning.AI

update language setting

Developing

PUT

/language-settings/{id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Example:

66a87a989127d5a8ce50d6aa

Body Params application/json

communityText

string

required

openaiApiKey

string

required

aiMessageTranslation

boolean

required

supportedLanguages

array[string]

required

language

string

required

Example

{
  "communityText": "Welcome to our community!",
  "openaiApiKey": "sk-1234567890abcdef",
  "aiMessageTranslation": true,
  "supportedLanguages": [
    "en",
    "de",
    "fr"
  ],
  "language": "fr"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.returning.ai/api/v1/language-settings/66a87a989127d5a8ce50d6aa' \
--header 'Content-Type: application/json' \
--data-raw '{
  "communityText": "Welcome to our community!",
  "openaiApiKey": "sk-1234567890abcdef",
  "aiMessageTranslation": true,
  "supportedLanguages": [
    "en",
    "de",
    "fr"
  ],
  "language": "fr"
}'

Responses

🟢200Success

application/json

Body

meta

object

required

success

boolean

required

message

string

required

devMessage

string

required

body

object

required

_id

string

required

serverId

string

required

userId

string

required

communityText

string

required

openaiApiKey

string

required

aiMessageTranslation

boolean

required

supportedLanguages

array[string]

required

language

string

required

createdAt

string

required

updatedAt

string

required

__v

integer

required

Example

{
  "meta": {
    "success": true,
    "message": "Language setting has been updated successfully",
    "devMessage": "Language setting has been updated successfully"
  },
  "body": {
    "_id": "66a28145fe1c8797121428ba",
    "serverId": "60d0fe4f5311236168a109ca",
    "userId": "1",
    "communityText": "Welcome to our community!",
    "openaiApiKey": "sk-1234567890abcdef",
    "aiMessageTranslation": true,
    "supportedLanguages": [
      "en",
      "de",
      "fr"
    ],
    "language": "en",
    "createdAt": "2024-07-25T16:45:57.606Z",
    "updatedAt": "2024-07-25T16:47:45.941Z",
    "__v": 0
  }
}

Modified at 2024-07-30 05:31:13

create new language setting

delete language setting