Phrase Glossary Term Translations API
The Glossary Term Translations API from Phrase — 2 operation(s) for glossary term translations.
OpenAPI Specification
openapi: 3.0.3
info:
title: Phrase Strings API Reference Accounts Glossary Term Translations API
version: 2.0.0
description: Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.
contact:
name: Phrase Support
url: https://developers.phrase.com/api/
email: support@phrase.com
x-logo:
url: https://developers.phrase.com/images/phrase-logo.svg
backgroundColor: '#03eab3'
altText: Phrase Strings
termsOfService: https://phrase.com/terms/
license:
name: MIT
url: https://choosealicense.com/licenses/mit/
servers:
- url: https://api.phrase.com/v2
description: EU production server
- url: https://api.us.app.phrase.com/v2
description: US production server
security:
- Token: []
- Basic: []
tags:
- name: Glossary Term Translations
paths:
/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations:
post:
summary: Create a translation for a term
description: 'Create a new translation for a term in a term base (previously: glossary).'
operationId: glossary_term_translation/create
tags:
- Glossary Term Translations
parameters:
- $ref: '#/components/parameters/X-PhraseApp-OTP'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/glossary_id'
- $ref: '#/components/parameters/term_id'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/glossary_term_translation'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-code-samples:
- lang: Curl
source: "curl \"https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X POST \\\n -d '{\"locale_code\":\"en-US\",\"content\":\"My translated term\"}' \\\n -H 'Content-Type: application/json'"
- lang: CLI v2
source: 'phrase glossary_term_translations create \
--account_id <account_id> \
--glossary_id <glossary_id> \
--term_id <term_id> \
--data ''{"locale_code":"en-US", "content": "My translated term"}'' \
--access_token <token>'
requestBody:
required: true
content:
application/json:
schema:
type: object
title: glossary_term_translation/create/parameters
required:
- locale_code
- content
properties:
locale_code:
description: Identifies the language for this translation
type: string
example: en-US
content:
description: The content of the translation
type: string
example: My translated term
x-cli-version: '2.5'
/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}:
patch:
summary: Update a translation for a term
description: 'Update an existing translation for a term in a term base (previously: glossary).'
operationId: glossary_term_translation/update
tags:
- Glossary Term Translations
parameters:
- $ref: '#/components/parameters/X-PhraseApp-OTP'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/glossary_id'
- $ref: '#/components/parameters/term_id'
- $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/glossary_term_translation'
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-code-samples:
- lang: Curl
source: "curl \"https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X PATCH \\\n -d '{\"locale_code\":\"en-US\",\"content\":\"My translated term\"}' \\\n -H 'Content-Type: application/json'"
- lang: CLI v2
source: 'phrase glossary_term_translations update \
--account_id <account_id> \
--glossary_id <glossary_id> \
--term_id <term_id> \
--id <id> \
--data ''{"locale_code":"en-US", "content": "My translated term"}'' \
--access_token <token>'
requestBody:
required: true
content:
application/json:
schema:
type: object
title: glossary_term_translation/update/parameters
properties:
locale_code:
description: Identifies the language for this translation
type: string
example: en-US
content:
description: The content of the translation
type: string
example: My translated term
x-cli-version: '2.5'
delete:
summary: Delete a translation for a term
description: 'Delete an existing translation of a term in a term base (previously: glossary).'
operationId: glossary_term_translation/delete
tags:
- Glossary Term Translations
parameters:
- $ref: '#/components/parameters/X-PhraseApp-OTP'
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/glossary_id'
- $ref: '#/components/parameters/term_id'
- $ref: '#/components/parameters/id'
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-code-samples:
- lang: Curl
source: "curl \"https://api.phrase.com/v2/accounts/:account_id/glossaries/:glossary_id/terms/:term_id/translations/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X DELETE"
- lang: CLI v2
source: 'phrase glossary_term_translations delete \
--account_id <account_id> \
--glossary_id <glossary_id> \
--term_id <term_id> \
--id <id> \
--access_token <token>'
x-cli-version: '2.5'
components:
responses:
'429':
description: Rate Limiting
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
'400':
description: Bad request
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
'404':
description: Not Found
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
'204':
description: The resource was deleted successfully.
headers:
X-Rate-Limit-Limit:
$ref: '#/components/headers/X-Rate-Limit-Limit'
X-Rate-Limit-Remaining:
$ref: '#/components/headers/X-Rate-Limit-Remaining'
X-Rate-Limit-Reset:
$ref: '#/components/headers/X-Rate-Limit-Reset'
headers:
X-Rate-Limit-Reset:
description: Timestamp of end of current time period as UNIX timestamp, see [Rate Limiting](/en/api/strings/pagination#rate-limiting)
schema:
type: integer
X-Rate-Limit-Limit:
description: The number of allowed requests in the current period
schema:
type: integer
X-Rate-Limit-Remaining:
description: The number of remaining requests in the current period
schema:
type: integer
parameters:
X-PhraseApp-OTP:
in: header
name: X-PhraseApp-OTP
description: Two-Factor-Authentication token (optional)
required: false
allowEmptyValue: false
schema:
type: string
account_id:
in: path
name: account_id
description: Account ID
required: true
schema:
type: string
term_id:
in: path
name: term_id
description: Term ID
required: true
schema:
type: string
glossary_id:
in: path
name: glossary_id
description: Glossary ID
required: true
schema:
type: string
id:
in: path
name: id
description: ID
required: true
schema:
type: string
schemas:
glossary_term_translation:
type: object
title: glossary_term_translation
properties:
id:
type: string
locale_code:
type: string
content:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
example:
id: abcd1234cdef1234abcd1234cdef1234
locale_code: en-US
content: Save
created_at: '2015-01-28T09:52:53Z'
updated_at: '2015-01-28T09:52:53Z'
securitySchemes:
Token:
type: apiKey
in: header
name: Authorization
description: Enter your token in the format `token TOKEN`
Basic:
type: http
scheme: basic
x-tagGroups:
- name: Core Resources
tags:
- Projects
- Locales
- Keys
- Translations
- Uploads
- Tags
- Custom Metadata Properties
- Blacklisted Keys
- Versions / History
- name: Workflows
tags:
- Spaces
- Jobs
- Job Comments
- Job Locales
- Job Templates
- Job Template Locales
- Organization Job Templates
- Organization Job Template Locales
- Comments
- Comment Reactions
- Comment Replies
- Branches
- name: Quality
tags:
- Glossaries
- Glossary Terms
- Glossary Term Translations
- name: Integrations
tags:
- Webhooks
- Distributions
- Releases
- Release Triggers
- name: Ordering
tags:
- Orders
- Style guides
- name: User management
tags:
- Authorizations
- Users
- Accounts
- Members
- Invitations
- name: Screenshots
tags:
- Screenshots
- Screenshot Markers
- name: Misc
tags:
- Formats
- name: Figma Attachments
tags:
- Figma attachments
- Key's Figma attachments