ExtraKey

Import own keys from a CSV

CSV header `name,context,<lang_bcp>…` (language columns are tenant languages). Rows with errors are reported and skipped; when `used + valid rows` crosses `max_keys` the whole file is refused with 409.

POST
/api/v2/tenants/{tenantId}/extra-keys/import

Authorization

BearerAuthObject
AuthorizationBearer <token>

Machine tokens only: a personal API token or a product robot token (POST /api/v2/products/{uid}/robot-tokens). A session JWT here is 401 — the web app uses the b2t_access cookie.

In: header

Path Parameters

tenantId*string

UUID of the tenant

Formatuuid

Query Parameters

dryRun?integer

1 = report only, write nothing

Value in

  • 0
  • 1

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/extra-keys/import" \  -F file="string"
{  "dryRun": true,  "total": 0,  "valid": 0,  "invalid": 0,  "rows": [    {}  ]}
Empty
{  "message": {    "error": "Your request was made with invalid credentials."  }}
{  "message": {    "error": "You are not allowed to perform this action."  }}
Empty