Product DocumentationConga Community
API Reference

Automatically translate the schema of an object based on the provided metadata and target locale(s)

post
https://rls.congacloud.com/api/localization-admin/v1/translations/schema-auto-translate

This endpoint processes the given object metadata and generates translations for all translatable elements
such as display names, descriptions, and field labels. The operation is executed asynchronously.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
targetLocales
array of strings

Optional list of target locale(s) for translation. If not provided, default locales will be used.

targetLocales
Body Params

The metadata of the object to be translated, including its name, display name,
description, fields, and other properties that will be translated.

Note: The object metadata must be provided in English only. This ensures accurate translationsto the target locale(s).

string | null
string | null
string | null
boolean
boolean
boolean
boolean
boolean
boolean
string | null
string
enum
Allowed:
boolean
FieldMetadata
array of objects | null
FieldMetadata
InternalRuntimeAliasFields
array of objects | null
InternalRuntimeAliasFields
InternalPrecomputedAliasFields
array of objects | null
InternalPrecomputedAliasFields
PicklistMetadata
array of objects | null
PicklistMetadata
DependentPicklistMetadata
array of objects | null
DependentPicklistMetadata
ComplexFieldMetadata
array of objects | null
ComplexFieldMetadata
AliasFieldMetadata
array of objects | null
AliasFieldMetadata
IndexMetadata
array of objects | null
IndexMetadata
TtlFieldMetadata
object
CreatedBy
object
date-time
ModifiedBy
object
date-time
Attributes
object
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Invalid request or object metadata

403

Forbidden

500

Internal server error during translation processing

Updated 20 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago