Skip to main content
POST
Import glossary rows without clearing existing entries. Merge updates matching terms; ignore preserves them.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: glossary:write. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.Format: “uuid”. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
required
Text value.Minimum length: 2. Maximum length: 64.
string
Text value.Allowed values: “merge”, “replace”, “ignore”. Default: “merge”.
array
required
List of values. See the complete input schema for its item structure.Minimum items: 1. Maximum items: 500.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Returns the import summary with imported row count, resulting entry count, and invalid or skipped rows.

Result fields

Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.
HTTP 200

Operation notes

  • Accepts 1–500 structured rows with 1–200 target languages per row. Each target object requires text and mode.
  • merge is the default. ignore skips source terms already present and reports them in invalidRows.
  • The current implementation accepts replace but saves through the same merge operation; it does not remove entries omitted from the payload. Do not rely on replace to clear an existing glossary.
  • Duplicate source terms and unknown target languages are reported as invalid rows. The request fails if no valid rows remain.
  • When a row target omits applicationMode, the import currently assigns strict to that target. Supply smart or strict explicitly when the desired mode matters.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors