Copy-edit / translate a deal

Operation

POST /deals/{id}/translate

Runs the HiEnergy AI copy-editor on a deal's title/description (optionally into another language). Admin-only.

Parameters

Request Body

{
  "required": false,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "target_language": {
            "type": "string",
            "description": "ISO-639-1 language code (e.g. 'en', 'fr'). Defaults to the deal's locale."
          },
          "tone": {
            "type": "string",
            "description": "Optional tone hint for the copy-editor"
          }
        }
      },
      "examples": {
        "translate_to_french": {
          "summary": "Translate to French",
          "value": {
            "target_language": "fr"
          }
        }
      }
    }
  }
}

Responses

{
  "description": "Updated deal",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Deal"
          }
        },
        "required": [
          "data"
        ]
      }
    }
  }
}

{
  "$ref": "#/components/responses/Unauthorized"
}

{
  "$ref": "#/components/responses/Forbidden"
}

{
  "$ref": "#/components/responses/NotFound"
}

{
  "description": "Translation failed or validation errors",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

API Playground

The in-page tester only supports GET. For POST, use the sample curl below or the dedicated resource docs (e.g. Contacts, Link Builder). Sign in to enable live testing with your API key.

Example request (replace YOUR_API_KEY or sign in above):

curl -X POST "https://app.hienergy.ai/api/v1/deals/1/translate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"
  -H "Content-Type: application/json" \
  -d '{}'