Tolgee Octri Demo
POST/v2/organizations/{organizationId}/glossaries/{glossaryId}/import

Import glossary terms from CSV

Imports glossary terms from a CSV file into an organization's glossary. Send the file in the multipart file field; set removeExistingTerms to true if the import should remove existing terms.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 1 body field
organizationIdintegerrequired
The integer identifier of the organization that owns the glossary.
glossaryIdintegerrequired
The integer identifier of the glossary to import terms into.
removeExistingTermsbooleanoptional
Whether to remove existing glossary terms during the import. Defaults to false when omitted.
Default:false

Multipart form data containing the CSV file to import.

filestringrequired
The CSV file containing the glossary terms to import.

5 status codes
200Returns the number of terms imported.
importedintegerrequired
Number of imported terms
400Returned when the request or CSV file is invalid, or the required `file` field is missing.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have access to the requested resource.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the organization or glossary is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates an invalid request; a 401 indicates missing or invalid authentication; a 403 indicates the authenticated user lacks access; and a 404 indicates the organization or glossary was not found. The organizationId and glossaryId path parameters must be integers. The file field is required and must contain the CSV file.