suggestCustomFieldTranslations

Requires permission settings:custom-fields:manage.

Suggests translations of a custom field's name, help text and choice labels into the requested languages, with Minori. Synchronous; saves nothing (the admin reviews and saves the field); meters AI credits. Requires the Minori plan feature and permission to manage custom fields.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SuggestCustomFieldTranslations($input: SuggestCustomFieldTranslationsInput!) {
  suggestCustomFieldTranslations(input: $input) {
    helpText
    labels
    options
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SuggestCustomFieldTranslations($input: SuggestCustomFieldTranslationsInput!) {\n  suggestCustomFieldTranslations(input: $input) {\n    helpText\n    labels\n    options\n  }\n}",
  "variables": {
    "input": {
      "label": "string",
      "locales": [
        "string"
      ],
      "sourceLocale": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "label": "string",
    "locales": [
      "string"
    ],
    "sourceLocale": "string"
  }
}

Response:

{
  "data": {
    "suggestCustomFieldTranslations": {
      "helpText": {},
      "labels": {},
      "options": {}
    }
  }
}

suggestCustomFieldTranslations(
  input: SuggestCustomFieldTranslationsInput!
): CustomFieldTranslationSuggestion!

Arguments

suggestCustomFieldTranslations.input ● SuggestCustomFieldTranslationsInput! non-null input

The field's text in one language and the languages wanted.

Type

CustomFieldTranslationSuggestion object

Suggested translations of a custom field's text. Nothing is saved: the admin reviews them and saves the field.