Phrase Component

Phrase is a translation management platform for software projects

Component key: phrase

Description

Phrase is a translation management platform for software projects.

Phrase Connections

Basic

Input	Notes
Input Password password / Required	Notes
Input Username string / Required	Notes

Token

Input	Notes
Input API Key password / Required	Notes

Actions

Account Locales

List locales used in account | key: accountLocales

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Account Show

Get a single account | key: accountShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Accounts List

List accounts | key: accountsList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Authorization Create

Create an authorization | key: authorizationCreate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Expires At string	Notes Expiration date for the authorization token	Example 2015-03-30T09:52:53Z
Input Note string	Notes A note to help you remember what the access is used for	Example My Deploy Script
Input Scopes string	Notes A list of scopes that the access can be used for	Example read,write

---

Authorization Delete

Delete an authorization | key: authorizationDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Authorization Show

Get a single authorization | key: authorizationShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Authorization Update

Update an authorization | key: authorizationUpdate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Expires At string	Notes Expiration date for the authorization token	Example 2015-03-30T09:52:53Z
Input Id string / Required	Notes ID	Example
Input Note string	Notes A note to help you remember what the access is used for	Example My Deploy Script
Input Scopes string	Notes A list of scopes that the access can be used for	Example read,write

---

Authorizations List

List authorizations | key: authorizationsList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Bitbucket Sync Export

Export from Phrase to Bitbucket | key: bitbucketSyncExport

Input	Notes	Example
Input Account Id string	Notes Account ID to specify the actual account the project should be created in	Example abcd1234
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example

---

Bitbucket Sync Import

Import to Phrase from Bitbucket | key: bitbucketSyncImport

Input	Notes	Example
Input Account Id string	Notes Account ID to specify the actual account the project should be created in	Example abcd1234
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example

---

Bitbucket Syncs List

List Bitbucket syncs | key: bitbucketSyncsList

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the project should be created in
Input Connection connection / Required	Notes

---

Blacklisted Key Create

Create a blacklisted key | key: blacklistedKeyCreate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Blacklisted key name	Example date.formats.*
Input Project Id string / Required	Notes Project ID	Example

---

Blacklisted Key Delete

Delete a blacklisted key | key: blacklistedKeyDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Blacklisted Key Show

Get a single blacklisted key | key: blacklistedKeyShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Blacklisted Key Update

Update a blacklisted key | key: blacklistedKeyUpdate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Name string	Notes Blacklisted key name	Example date.formats.*
Input Project Id string / Required	Notes Project ID	Example

---

Blacklisted Keys List

List blacklisted keys | key: blacklistedKeysList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Branch Compare

Compare branches | key: branchCompare

Input	Notes
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Name string	Notes Name of the branch
Input Project Id string / Required	Notes Project ID

---

Branch Create

Create a branch | key: branchCreate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the branch	Example my-branch
Input Project Id string / Required	Notes Project ID	Example

---

Branch Delete

Delete a branch | key: branchDelete

Input	Notes
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Branch Merge

Merge a branch | key: branchMerge

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes name	Example
Input Project Id string / Required	Notes Project ID	Example
Input Strategy string	Notes strategy used for merge blocking, use_master or use_branch	Example use_master

---

Branch Show

Get a single branch | key: branchShow

Input	Notes
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Branch Update

Update a branch | key: branchUpdate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes name	Example
Input Name string	Notes Name of the branch	Example my-branch
Input Project Id string / Required	Notes Project ID	Example

---

Branches List

List branches | key: branchesList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Comment Create

Create a comment | key: commentCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Key Id string / Required	Notes Translation Key ID	Example
Input Message string	Notes Comment message	Example Some message...
Input Project Id string / Required	Notes Project ID	Example

---

Comment Delete

Delete a comment | key: commentDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Key Id string / Required	Notes Translation Key ID
Input Project Id string / Required	Notes Project ID

---

Comment Mark Check

Check if comment is read | key: commentMarkCheck

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Key Id string / Required	Notes Translation Key ID
Input Project Id string / Required	Notes Project ID

---

Comment Mark Read

Mark a comment as read | key: commentMarkRead

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Key Id string / Required	Notes Translation Key ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Comment Mark Unread

Mark a comment as unread | key: commentMarkUnread

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Key Id string / Required	Notes Translation Key ID
Input Project Id string / Required	Notes Project ID

---

Comment Show

Get a single comment | key: commentShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Key Id string / Required	Notes Translation Key ID
Input Project Id string / Required	Notes Project ID

---

Comment Update

Update a comment | key: commentUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Key Id string / Required	Notes Translation Key ID	Example
Input Message string	Notes Comment message	Example Some message...
Input Project Id string / Required	Notes Project ID	Example

---

Comments List

List comments | key: commentsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Key Id string / Required	Notes Translation Key ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Distribution Create

Create a distribution | key: distributionCreate

Input	Default	Notes	Example
Input Account Id string / Required	Default	Notes Account ID	Example
Input Connection connection / Required	Default	Notes	Example
Input Fallback To Default Locale boolean	Default false	Notes Indicates whether to fallback to projects default locale when locale can not be found	Example true
Input Fallback To Non Regional Locale boolean	Default false	Notes Indicates whether to fallback to non regional locale when locale can not be found	Example true
Input Format Options string	Default	Notes Additional formatting and render options	Example {xml:{enclose_in_cdata:'1'}}
Input Locale Ids string	Default	Notes List of locale ids that will be part of distribution releases	Example abcd1234cdef1234abcd1234cdef1234,fff565db236400772368235db2c6117e
Input Name string	Default	Notes Name of the distribution	Example My Android Distribution
Input Platforms string	Default	Notes List of platforms the distribution should support	Example android,ios
Input Project Id string	Default	Notes Project id the distribution should be assigned to	Example abcd1234abcd1234abcd1234
Input Use Last Reviewed Version boolean	Default false	Notes Use last reviewed instead of latest translation in a project	Example true

---

Distribution Delete

Delete a distribution | key: distributionDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Distribution Show

Get a single distribution | key: distributionShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Distribution Update

Update a distribution | key: distributionUpdate

Input	Default	Notes	Example
Input Account Id string / Required	Default	Notes Account ID	Example
Input Connection connection / Required	Default	Notes	Example
Input Fallback To Default Locale boolean	Default false	Notes Indicates whether to fallback to projects default locale when locale can not be found	Example true
Input Fallback To Non Regional Locale boolean	Default false	Notes Indicates whether to fallback to non regional locale when locale can not be found	Example true
Input Format Options string	Default	Notes Additional formatting and render options	Example {xml:{enclose_in_cdata:'1'}}
Input Id string / Required	Default	Notes ID	Example
Input Locale Ids string	Default	Notes List of locale ids that will be part of distribution releases	Example abcd1234cdef1234abcd1234cdef1234,fff565db236400772368235db2c6117e
Input Name string	Default	Notes Name of the distribution	Example My Android Distribution
Input Platforms string	Default	Notes List of platforms the distribution should support	Example android,ios
Input Project Id string	Default	Notes Project id the distribution should be assigned to	Example abcd1234abcd1234abcd1234
Input Use Last Reviewed Version boolean	Default false	Notes Use last reviewed instead of latest translation in a project	Example true

---

Distributions List

List distributions | key: distributionsList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Document Delete

Delete document | key: documentDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Documents List

List documents | key: documentsList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Formats List

List formats | key: formatsList

Input	Notes
Input Connection connection / Required	Notes

---

Github Sync Export

Export from Phrase to GitHub | key: githubSyncExport

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project Id string	Notes Project ID to specify the actual project the GitHub export should be triggered in	Example abcd1234

---

Github Sync Import

Import to Phrase from GitHub | key: githubSyncImport

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project Id string	Notes Project ID to specify the actual project the GitHub import should be triggered in	Example abcd1234

---

Gitlab Sync Delete

Delete single Sync Setting | key: gitlabSyncDelete

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Gitlab Sync Export

Export from Phrase to GitLab | key: gitlabSyncExport

Input	Notes	Example
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in	Example abcd1234
Input Connection connection / Required	Notes	Example
Input Gitlab Sync Id string / Required	Notes Gitlab Sync ID	Example

---

Gitlab Sync History

History of single Sync Setting | key: gitlabSyncHistory

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in
Input Connection connection / Required	Notes
Input Gitlab Sync Id string / Required	Notes Gitlab Sync ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Gitlab Sync Import

Import from GitLab to Phrase | key: gitlabSyncImport

Input	Notes	Example
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in	Example abcd1234
Input Connection connection / Required	Notes	Example
Input Gitlab Sync Id string / Required	Notes Gitlab Sync ID	Example

---

Gitlab Sync List

List GitLab syncs | key: gitlabSyncList

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in
Input Connection connection / Required	Notes

---

Gitlab Sync Show

Get single Sync Setting | key: gitlabSyncShow

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Gitlab Sync Update

Update single Sync Setting | key: gitlabSyncUpdate

Input	Notes
Input Account Id string	Notes Account ID to specify the actual account the GitLab Sync should be created in
Input Connection connection / Required	Notes
Input Gitlab Branch Name string	Notes Name of the GitLab Branch
Input Gitlab Project Id string	Notes ID of the related GitLab Project
Input Id string / Required	Notes ID
Input Phrase Project Code string	Notes Code of the related Phrase Project

---

Glossaries List

List glossaries | key: glossariesList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Glossary Create

Create a glossary | key: glossaryCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the glossary	Example My glossary
Input Project Ids string	Notes List of project ids the glossary should be assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Space Ids string	Notes List of space ids the glossary should be assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235

---

Glossary Delete

Delete a glossary | key: glossaryDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Glossary Show

Get a single glossary | key: glossaryShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Glossary Term Create

Create a glossary term | key: glossaryTermCreate

Input	Default	Notes	Example
Input Account Id string / Required	Default	Notes Account ID	Example
Input Case Sensitive boolean	Default false	Notes Indicates whether the term is case sensitive	Example true
Input Connection connection / Required	Default	Notes	Example
Input Description string	Default	Notes Description of term	Example Use this when refering to our company
Input Glossary Id string / Required	Default	Notes Glossary ID	Example
Input Term string	Default	Notes Glossary term	Example MyCompany
Input Translatable boolean	Default false	Notes Indicates whether the term should be used for all languages or can be translated	Example true

---

Glossary Term Delete

Delete a glossary term | key: glossaryTermDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Glossary Id string / Required	Notes Glossary ID
Input Id string / Required	Notes ID

---

Glossary Term Show

Get a single glossary term | key: glossaryTermShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Glossary Id string / Required	Notes Glossary ID
Input Id string / Required	Notes ID

---

Glossary Term Translation Create

Create a glossary term translation | key: glossaryTermTranslationCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Content string	Notes The content of the translation	Example My translated term
Input Glossary Id string / Required	Notes Glossary ID	Example
Input Locale Code string	Notes Identifies the language for this translation	Example en-US
Input Term Id string / Required	Notes Term ID	Example

---

Glossary Term Translation Delete

Delete a glossary term translation | key: glossaryTermTranslationDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Glossary Id string / Required	Notes Glossary ID
Input Id string / Required	Notes ID
Input Term Id string / Required	Notes Term ID

---

Glossary Term Translation Update

Update a glossary term translation | key: glossaryTermTranslationUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Content string	Notes The content of the translation	Example My translated term
Input Glossary Id string / Required	Notes Glossary ID	Example
Input Id string / Required	Notes ID	Example
Input Locale Code string	Notes Identifies the language for this translation	Example en-US
Input Term Id string / Required	Notes Term ID	Example

---

Glossary Term Update

Update a glossary term | key: glossaryTermUpdate

Input	Default	Notes	Example
Input Account Id string / Required	Default	Notes Account ID	Example
Input Case Sensitive boolean	Default false	Notes Indicates whether the term is case sensitive	Example true
Input Connection connection / Required	Default	Notes	Example
Input Description string	Default	Notes Description of term	Example Use this when refering to our company
Input Glossary Id string / Required	Default	Notes Glossary ID	Example
Input Id string / Required	Default	Notes ID	Example
Input Term string	Default	Notes Glossary term	Example MyCompany
Input Translatable boolean	Default false	Notes Indicates whether the term should be used for all languages or can be translated	Example true

---

Glossary Terms List

List glossary terms | key: glossaryTermsList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Glossary Id string / Required	Notes Glossary ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Glossary Update

Update a glossary | key: glossaryUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Name string	Notes Name of the glossary	Example My glossary
Input Project Ids string	Notes List of project ids the glossary should be assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Space Ids string	Notes List of space ids the glossary should be assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235

---

Icu Skeleton

Build icu skeletons | key: icuSkeleton

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Content string	Default	Notes Source content	Example {number, plural, one {One} other {%{n}}}
Input Keep Content boolean	Default false	Notes Keep the content and add missing plural forms for each locale	Example null
Input Locale Codes string	Default	Notes Locale codes	Example en
Input Zero Form Enabled boolean	Default false	Notes Indicates whether the zero form should be included or excluded in the returned skeletons	Example null

---

Invitation Create

Create a new invitation | key: invitationCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Default Locale Codes string	Notes List of default locales for the user	Example en,de
Input Email string	Notes The email of the invited user	Example example@mail.com
Input Locale Ids string	Notes List of locale ids the invited user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Permissions string	Notes Additional permissions depending on invitation role	Example [object Object]
Input Project Ids string	Notes List of project ids the invited user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Role string	Notes Invitiation role, can be any of Manager, Developer, Translator	Example Developer
Input Space Ids string	Notes List of spaces the user is assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Team Ids string	Notes List of teams the user is assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235

---

Invitation Delete

Delete an invitation | key: invitationDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Invitation Resend

Resend an invitation | key: invitationResend

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Invitation Show

Get a single invitation | key: invitationShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Invitation Update

Update an invitation | key: invitationUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Default Locale Codes string	Notes List of default locales for the user	Example en,de
Input Id string / Required	Notes ID	Example
Input Locale Ids string	Notes List of locale ids the invited user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Permissions string	Notes Additional permissions depending on invitation role	Example [object Object]
Input Project Ids string	Notes List of project ids the invited user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Role string	Notes Invitiation role, can be any of Manager, Developer, Translator	Example Invitiation role
Input Space Ids string	Notes List of spaces the user is assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Team Ids string	Notes List of teams the user is assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235

---

Invitation Update Settings

Update a member"s invitation access | key: invitationUpdateSettings

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Locale Ids string	Notes List of locale ids the user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Project Id string / Required	Notes Project ID	Example
Input Project Role string	Notes Member role, can be any of of Manager, Developer, Translator	Example Developer

---

Invitations List

List invitations | key: invitationsList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Job Complete

Complete a job | key: jobComplete

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Create

Create a job | key: jobCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Briefing string	Notes Briefing for the translators	Example de-DE
Input Connection connection / Required	Notes	Example
Input Due Date string	Notes Date the job should be finished	Example 2017-08-15
Input Job Template Id string	Notes id of a job template you would like to model the created job after	Example abcd1234cdef1234abcd1234cdef1234
Input Name string	Notes Job name	Example de
Input Project Id string / Required	Notes Project ID	Example
Input Source Locale Id string	Notes The API id of the source language	Example abcd1234cdef1234abcd1234cdef1234
Input Tags string	Notes tags of keys that should be included within the job	Example myUploadTag
Input Ticket Url string	Notes URL to a ticket for this job (e	Example https://example.atlassian.net/browse/FOO
Input Translation Key Ids string	Notes ids of keys that should be included within the job	Example abcd1234cdef1234abcd1234cdef1234

---

Job Delete

Delete a job | key: jobDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Keys Create

Add keys to job | key: jobKeysCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example
Input Translation Key Ids string	Notes ids of keys that should added to the job	Example abcd1234cdef1234abcd1234cdef1234

---

Job Keys Delete

Remove keys from job | key: jobKeysDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID
Input Translation Key Ids string	Notes ids of keys that should added to the job

---

Job Locale Complete

Complete a job locale | key: jobLocaleComplete

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Job Id string / Required	Notes Job ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Locale Complete Review

Review a job locale | key: jobLocaleCompleteReview

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Job Id string / Required	Notes Job ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Locale Delete

Delete a job locale | key: jobLocaleDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Job Id string / Required	Notes Job ID
Input Project Id string / Required	Notes Project ID

---

Job Locale Reopen

Reopen a job locale | key: jobLocaleReopen

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Job Id string / Required	Notes Job ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Locale Show

Get a single job locale | key: jobLocaleShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Job Id string / Required	Notes Job ID
Input Project Id string / Required	Notes Project ID

---

Job Locale Update

Update a job locale | key: jobLocaleUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Job Id string / Required	Notes Job ID	Example
Input Locale Id string	Notes locale id	Example abcd1234cdef1234abcd1234cdef1234
Input Project Id string / Required	Notes Project ID	Example
Input Reviewer Ids string	Notes Array of reviewer ids to be assigned to the job locale as reviewers	Example abcd1234cdef1234abcd1234cdef1234
Input User Ids string	Notes Array of user ids to be assigned to the job locale	Example abcd1234cdef1234abcd1234cdef1234

---

Job Locales Create

Create a job locale | key: jobLocalesCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Job Id string / Required	Notes Job ID	Example
Input Locale Id string	Notes locale id	Example abcd1234cdef1234abcd1234cdef1234
Input Project Id string / Required	Notes Project ID	Example
Input Reviewer Ids string	Notes Array of reviewer ids to be assigned to the job locale as reviewers	Example abcd1234cdef1234abcd1234cdef1234
Input User Ids string	Notes Array of user ids to be assigned to the job locale as translators	Example abcd1234cdef1234abcd1234cdef1234

---

Job Locales List

List job locales | key: jobLocalesList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Job Id string / Required	Notes Job ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Job Lock

Lock a job | key: jobLock

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Reopen

Reopen a job | key: jobReopen

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Show

Get a single job | key: jobShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Start

Start a job | key: jobStart

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Job Template Create

Create a job template | key: jobTemplateCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Briefing string	Notes Briefing for the translators	Example text
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes Job template name	Example template
Input Project Id string / Required	Notes Project ID	Example

---

Job Template Delete

Delete a job template | key: jobTemplateDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Template Locale Delete

Delete a job template locale | key: jobTemplateLocaleDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Job Template Id string / Required	Notes Job Template ID
Input Job Template Locale Id string / Required	Notes Job Template Locale ID
Input Project Id string / Required	Notes Project ID

---

Job Template Locale Show

Get a single job template locale | key: jobTemplateLocaleShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Job Template Id string / Required	Notes Job Template ID
Input Job Template Locale Id string / Required	Notes Job Template Locale ID
Input Project Id string / Required	Notes Project ID

---

Job Template Locale Update

Update a job template locale | key: jobTemplateLocaleUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Job Template Id string / Required	Notes Job Template ID	Example
Input Job Template Locale Id string / Required	Notes Job Template Locale ID	Example
Input Locale Id string / Required	Notes locale id	Example abcd1234cdef1234abcd1234cdef1234
Input Project Id string / Required	Notes Project ID	Example
Input Reviewer Ids string	Notes Array of reviewer ids to be assigned to the job template locale	Example abcd1234cdef1234abcd1234cdef1234
Input User Ids string	Notes Array of user ids to be assigned to the job template locale	Example abcd1234cdef1234abcd1234cdef1234

---

Job Template Locales Create

Create a job template locale | key: jobTemplateLocalesCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Job Template Id string / Required	Notes Job Template ID	Example
Input Locale Id string / Required	Notes locale id	Example abcd1234cdef1234abcd1234cdef1234
Input Project Id string / Required	Notes Project ID	Example
Input Reviewer Ids string	Notes Array of reviewer ids to be assigned to the job template locale	Example abcd1234cdef1234abcd1234cdef1234
Input User Ids string	Notes Array of user ids to be assigned to the job template locale	Example abcd1234cdef1234abcd1234cdef1234

---

Job Template Locales List

List job template locales | key: jobTemplateLocalesList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Job Template Id string / Required	Notes Job Template ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Job Template Show

Get a single job template | key: jobTemplateShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Template Update

Update a job template | key: jobTemplateUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Briefing string	Notes Briefing for the translators	Example text
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Name string / Required	Notes Job template name	Example template
Input Project Id string / Required	Notes Project ID	Example

---

Job Templates List

List job templates | key: jobTemplatesList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Job Unlock

Unlock a job | key: jobUnlock

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Job Update

Update a job | key: jobUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Briefing string	Notes Briefing for the translators	Example de-DE
Input Connection connection / Required	Notes	Example
Input Due Date string	Notes Date the job should be finished	Example 2017-08-15
Input Id string / Required	Notes ID	Example
Input Name string	Notes Job name	Example de
Input Project Id string / Required	Notes Project ID	Example
Input Ticket Url string	Notes URL to a ticket for this job (e	Example https://example.atlassian.net/browse/FOO

---

Jobs By Account

List account jobs | key: jobsByAccount

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Assigned To string	Notes filter by user assigned to job
Input Connection connection / Required	Notes
Input Owned By string	Notes filter by user owning job
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input State string	Notes filter by state of job Valid states are draft, in_progress, completed

---

Jobs List

List jobs | key: jobsList

Input	Notes
Input Assigned To string	Notes filter by user assigned to job
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Owned By string	Notes filter by user owning job
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input State string	Notes filter by state of job Valid states are draft, in_progress, completed

---

Key Create

Create a key | key: keyCreate

Input	Default	Notes	Example
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Default	Notes	Example
Input Data Type string	Default	Notes Type of the key	Example number
Input Default Translation Content string	Default	Notes Creates a translation in the default locale with the specified content	Example Default translation content
Input Description string	Default	Notes Key description (usually includes contextual information for translators)	Example Some description worth knowing...
Input Localized Format Key string	Default	Notes NSStringLocalizedFormatKey attribute	Example null
Input Localized Format String string	Default	Notes NSStringLocalizedFormatKey attribute	Example null
Input Max Characters Allowed string	Default	Notes Max	Example 140
Input Name string	Default	Notes Key name	Example home.index.headline
Input Name Plural string	Default	Notes Plural name for the key (used in some file formats, e	Example home.index.headlines
Input Original File string	Default	Notes Original file attribute	Example null
Input Plural boolean	Default false	Notes Indicates whether key supports pluralization	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Remove Screenshot boolean	Default false	Notes Indicates whether the screenshot will be deleted	Example null
Input Screenshot string	Default	Notes Screenshot/image for the key	Example /path/to/my/screenshot.png
Input Tags string	Default	Notes List of tags separated by comma to be associated with the key	Example awesome-feature,needs-proofreading
Input Unformatted boolean	Default false	Notes Indicates whether the key should be exported as "unformatted"	Example null
Input Xml Space Preserve boolean	Default false	Notes Indicates whether the key should be exported with "xml:space=preserve"	Example null

---

Key Delete

Delete a key | key: keyDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Key Show

Get a single key | key: keyShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Key Update

Update a key | key: keyUpdate

Input	Default	Notes	Example
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Default	Notes	Example
Input Data Type string	Default	Notes Type of the key	Example number
Input Description string	Default	Notes Key description (usually includes contextual information for translators)	Example Some description worth knowing...
Input Id string / Required	Default	Notes ID	Example
Input Localized Format Key string	Default	Notes NSStringLocalizedFormatKey attribute	Example null
Input Localized Format String string	Default	Notes NSStringLocalizedFormatKey attribute	Example null
Input Max Characters Allowed string	Default	Notes Max	Example 140
Input Name string	Default	Notes Key name	Example home.index.headline
Input Name Plural string	Default	Notes Plural name for the key (used in some file formats, e	Example home.index.headlines
Input Original File string	Default	Notes Original file attribute	Example null
Input Plural boolean	Default false	Notes Indicates whether key supports pluralization	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Remove Screenshot boolean	Default false	Notes Indicates whether the screenshot will be deleted	Example null
Input Screenshot string	Default	Notes Screenshot/image for the key	Example /path/to/my/screenshot.png
Input Tags string	Default	Notes List of tags separated by comma to be associated with the key	Example awesome-feature,needs-proofreading
Input Unformatted boolean	Default false	Notes Indicates whether the key should be exported as "unformatted"	Example null
Input Xml Space Preserve boolean	Default false	Notes Indicates whether the key should be exported with "xml:space=preserve"	Example null

---

Keys Delete Collection

Delete collection of keys | key: keysDeleteCollection

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Locale Id string	Notes Locale used to determine the translation state of a key when filtering for untranslated or translated keys
Input Project Id string / Required	Notes Project ID
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)

---

Keys Exclude

Exclude a locale on a collection of keys | key: keysExclude

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)	Example mykey* translated:true
Input Tags string	Notes Tag or comma-separated list of tags to add to the matching collection of keys	Example landing-page,release-1.2
Input Target Locale Id string	Notes Locale used to exlcude or include keys	Example abcd1234abcd1234abcd1234abcd1234

---

Keys Include

Include a locale on a collection of keys | key: keysInclude

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)	Example mykey* translated:true
Input Tags string	Notes Tag or comma-separated list of tags to add to the matching collection of keys	Example landing-page,release-1.2
Input Target Locale Id string	Notes Locale used to exlcude or include keys	Example abcd1234abcd1234abcd1234abcd1234

---

Keys List

List keys | key: keysList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Locale Id string	Notes Locale used to determine the translation state of a key when filtering for untranslated or translated keys
Input Order string	Notes Order direction
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)
Input Sort string	Notes Sort by field

---

Keys Search

Search keys | key: keysSearch

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Locale Id string	Notes Locale used to determine the translation state of a key when filtering for untranslated or translated keys	Example abcd1234abcd1234abcd1234abcd1234
Input Order string	Notes Order direction	Example desc
Input Page string	Notes Page number	Example
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default	Example
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)	Example mykey* translated:true
Input Sort string	Notes Sort by field	Example updated_at

---

Keys Tag

Add tags to collection of keys | key: keysTag

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Locale Id string	Notes Locale used to determine the translation state of a key when filtering for untranslated or translated keys	Example abcd1234abcd1234abcd1234abcd1234
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)	Example mykey* translated:true
Input Tags string	Notes Tag or comma-separated list of tags to add to the matching collection of keys	Example landing-page,release-1.2

---

Keys Untag

Remove tags from collection of keys | key: keysUntag

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Locale Id string	Notes Locale used to determine the translation state of a key when filtering for untranslated or translated keys	Example abcd1234abcd1234abcd1234abcd1234
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to do broad search for keys by name (including wildcards)	Example mykey* translated:true
Input Tags string	Notes Tag or comma-separated list of tags to remove from the matching collection of keys	Example landing-page,release-1.2

---

Locale Create

Create a locale | key: localeCreate

Input	Default	Notes	Example
Input Autotranslate boolean	Default false	Notes If set, translations for this locale will be fetched automatically, right after creation	Example null
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Code string	Default	Notes Locale ISO code	Example de-DE
Input Connection connection / Required	Default	Notes	Example
Input Default boolean	Default false	Notes Indicates whether locale is the default locale	Example null
Input Main boolean	Default false	Notes Indicates whether locale is a main locale	Example null
Input Name string	Default	Notes Locale name	Example de
Input Project Id string / Required	Default	Notes Project ID	Example
Input Rtl boolean	Default false	Notes Indicates whether locale is a RTL (Right-to-Left) locale	Example null
Input Source Locale Id string	Default	Notes Source locale	Example abcd1234abcd1234abcd1234abcd1234
Input Unverify New Translations boolean	Default false	Notes Indicates that new translations for this locale should be marked as unverified	Example null
Input Unverify Updated Translations boolean	Default false	Notes Indicates that updated translations for this locale should be marked as unverified	Example null

---

Locale Delete

Delete a locale | key: localeDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Locale Download

Download a locale | key: localeDownload

Input	Default	Notes
Input Branch string	Default	Notes specify the branch to use
Input Connection connection / Required	Default	Notes
Input Convert Emoji boolean	Default false	Notes This option is obsolete
Input Encoding string	Default	Notes Enforces a specific encoding on the file contents
Input Exclude Empty Zero Forms boolean	Default false	Notes Indicates whether zero forms should be included when empty in pluralized keys
Input Fallback Locale Id string	Default	Notes If a key has no translation in the locale being downloaded the translation in the fallback locale will be used
Input File Format string	Default	Notes File format name
Input Format Options string	Default	Notes Additional formatting and render options
Input Id string / Required	Default	Notes ID
Input Include Empty Translations boolean	Default false	Notes Indicates whether keys without translations should be included in the output as well
Input Include Translated Keys boolean	Default false	Notes Include translated keys in the locale file
Input Include Unverified Translations boolean	Default false	Notes if set to false unverified translations are excluded
Input Keep Notranslate Tags boolean	Default false	Notes Indicates whether [NOTRANSLATE] tags should be kept
Input Project Id string / Required	Default	Notes Project ID
Input Skip Unverified Translations boolean	Default false	Notes Indicates whether the locale file should skip all unverified translations
Input Source Locale Id string	Default	Notes Provides the source language of a corresponding job as the source language of the generated locale file
Input Tag string	Default	Notes Limit download to tagged keys
Input Tags string	Default	Notes Limit results to keys tagged with a list of comma separated tag names
Input Use Last Reviewed Version boolean	Default false	Notes If set to true the last reviewed version of a translation is used

---

Locale Show

Get a single locale | key: localeShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Locale Update

Update a locale | key: localeUpdate

Input	Default	Notes	Example
Input Autotranslate boolean	Default false	Notes If set, translations for this locale will be fetched automatically, right after creation	Example null
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Code string	Default	Notes Locale ISO code	Example de-DE
Input Connection connection / Required	Default	Notes	Example
Input Default boolean	Default false	Notes Indicates whether locale is the default locale	Example null
Input Id string / Required	Default	Notes ID	Example
Input Main boolean	Default false	Notes Indicates whether locale is a main locale	Example null
Input Name string	Default	Notes Locale name	Example de
Input Project Id string / Required	Default	Notes Project ID	Example
Input Rtl boolean	Default false	Notes Indicates whether locale is a RTL (Right-to-Left) locale	Example null
Input Source Locale Id string	Default	Notes Source locale	Example abcd1234abcd1234abcd1234abcd1234
Input Unverify New Translations boolean	Default false	Notes Indicates that new translations for this locale should be marked as unverified	Example null
Input Unverify Updated Translations boolean	Default false	Notes Indicates that updated translations for this locale should be marked as unverified	Example null

---

Locales List

List locales | key: localesList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Sort By string	Notes Sort locales

---

Member Delete

Remove a user from the account | key: memberDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Member Show

Get single member | key: memberShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Member Update

Update a member | key: memberUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Default Locale Codes string	Notes List of default locales for the user	Example en,fi
Input Id string / Required	Notes ID	Example
Input Locale Ids string	Notes List of locale ids the user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Permissions string	Notes Additional permissions depending on member role	Example [object Object]
Input Project Ids string	Notes List of project ids the user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Role string	Notes Member role, can be any of of Admin, ProjectManager, Developer, Designer, Translator	Example Developer
Input Space Ids string	Notes List of spaces the user is assigned to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Strategy string	Notes Update strategy, can be any of set, add, remove	Example set

---

Member Update Settings

Update a member"s project settings | key: memberUpdateSettings

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Locale Ids string	Notes List of locale ids the user has access to	Example abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235
Input Project Id string / Required	Notes Project ID	Example
Input Project Role string	Notes Member role, can be any of of Manager, Developer, Translator	Example Developer

---

Members List

List members | key: membersList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Notification Groups List

List notification groups | key: notificationGroupsList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Notification Groups Mark All As Read

Mark all notification groups as read | key: notificationGroupsMarkAllAsRead

Input	Notes
Input Connection connection / Required	Notes

---

Notification Groups Mark As Read

Mark a notification group as read | key: notificationGroupsMarkAsRead

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Notifications List

List notifications | key: notificationsList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Notifications Mark All As Read

Mark all notifications as read | key: notificationsMarkAllAsRead

Input	Notes
Input Connection connection / Required	Notes

---

Notifications Show

Get a single notification | key: notificationsShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Order Confirm

Confirm an order | key: orderConfirm

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Order Create

Create a new order | key: orderCreate

Input	Default	Notes	Example
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Category string	Default	Notes Category to use (required for orders processed by TextMaster)	Example C021
Input Connection connection / Required	Default	Notes	Example
Input Include Untranslated Keys boolean	Default false	Notes Order translations for keys with untranslated content in the selected target locales	Example null
Input Include Unverified Translations boolean	Default false	Notes Order translations for keys with unverified content in the selected target locales	Example null
Input Lsp string	Default	Notes Name of the LSP that should process this order	Example textmaster
Input Message string	Default	Notes Message that is displayed to the translators for description	Example Please make everything sound really nice :)
Input Name string	Default	Notes the name of the order, default name is: Translation order from "current datetime"	Example Welcome message translations
Input Priority boolean	Default false	Notes Indicates whether the priority option should be ordered which decreases turnaround time by 30%	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Quality boolean	Default false	Notes Extra proofreading option to ensure consistency in vocabulary and style	Example null
Input Source Locale Id string	Default	Notes Source locale for the order	Example abcd1234abcd1234abcd1234abcd1234
Input Styleguide Id string	Default	Notes Style guide for translators to be sent with the order	Example 1234abcd1234abcd1234abcd1234abcd
Input Tag string	Default	Notes Tag you want to order translations for	Example my-awesome-feature
Input Target Locale Ids string	Default	Notes List of target locales you want the source content translate to	Example 1234abcd1234abcd1234abcd1234abcd,abcd1234abcd1234abcd1234abcd1234
Input Translation Type string	Default	Notes Name of the quality level, availability depends on the LSP	Example premium
Input Unverify Translations Upon Delivery boolean	Default false	Notes Unverify translations upon delivery	Example null

---

Order Delete

Cancel an order | key: orderDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Order Show

Get a single order | key: orderShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Orders List

List orders | key: ordersList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Project Create

Create a project | key: projectCreate

Input	Default	Notes	Example
Input Account Id string	Default	Notes Account ID to specify the actual account the project should be created in	Example abcd1234
Input Autotranslate Check New Locales boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Check New Translation Keys boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Check New Uploads boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Enabled boolean	Default false	Notes (Optional) Autopilot, requires machine_translation_enabled	Example true
Input Autotranslate Mark As Unverified boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Use Machine Translation boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Use Translation Memory boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Connection connection / Required	Default	Notes	Example
Input Enable All Data Type Translation Keys For Translators boolean	Default false	Notes (Optional) Otherwise, translators are not allowed to edit translations other than strings	Example true
Input Enable Branching boolean	Default false	Notes (Optional) Enable branching in the project	Example true
Input Enable Icu Message Format boolean	Default false	Notes (Optional) We can validate and highlight your ICU messages	Example true
Input Machine Translation Enabled boolean	Default false	Notes (Optional) Enable machine translation support in the project	Example true
Input Main Format string	Default	Notes Main file format specified by its API Extension name	Example yml
Input Name string	Default	Notes Name of the project	Example My Android Project
Input Project Image string	Default	Notes Image to identify the project	Example /path/to/my/project-screenshot.png
Input Protect Master Branch boolean	Default false	Notes (Optional) Protect the master branch in project where branching is enabled	Example true
Input Remove Project Image boolean	Default false	Notes Indicates whether the project image should be deleted	Example null
Input Shares Translation Memory boolean	Default false	Notes Indicates whether the project should share the account"s translation memory	Example true
Input Smart Suggest Enabled boolean	Default false	Notes (Optional) Smart Suggest, requires machine_translation_enabled	Example true
Input Smart Suggest Use Glossary boolean	Default false	Notes (Optional) Requires smart_suggest_enabled to be true	Example true
Input Smart Suggest Use Machine Translation boolean	Default false	Notes (Optional) Requires smart_suggest_enabled to be true	Example true
Input Source Project Id string	Default	Notes When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params	Example abcd1234
Input Workflow string	Default	Notes (Optional) Review Workflow	Example review
Input Zero Plural Form Enabled boolean	Default false	Notes (Optional) Displays the input fields for the "ZERO" plural form for every key as well although only some languages require the "ZERO" explicitly	Example true

---

Project Delete

Delete a project | key: projectDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Project Show

Get a single project | key: projectShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Project Update

Update a project | key: projectUpdate

Input	Default	Notes	Example
Input Account Id string	Default	Notes Required if the requesting user is a member of multiple accounts	Example abcd1234
Input Autotranslate Check New Locales boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Check New Translation Keys boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Check New Uploads boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Enabled boolean	Default false	Notes (Optional) Autopilot, requires machine_translation_enabled	Example true
Input Autotranslate Mark As Unverified boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Use Machine Translation boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Autotranslate Use Translation Memory boolean	Default false	Notes (Optional) Requires autotranslate_enabled to be true	Example true
Input Connection connection / Required	Default	Notes	Example
Input Enable All Data Type Translation Keys For Translators boolean	Default false	Notes (Optional) Otherwise, translators are not allowed to edit translations other than strings	Example true
Input Enable Branching boolean	Default false	Notes (Optional) Enable branching in the project	Example true
Input Enable Icu Message Format boolean	Default false	Notes (Optional) We can validate and highlight your ICU messages	Example true
Input Id string / Required	Default	Notes ID	Example
Input Machine Translation Enabled boolean	Default false	Notes (Optional) Enable machine translation support in the project	Example true
Input Main Format string	Default	Notes (Optional) Main file format specified by its API Extension name	Example yml
Input Name string	Default	Notes (Optional) Name of the project	Example My Android Project
Input Project Image string	Default	Notes (Optional) Image to identify the project	Example /path/to/my/project-screenshot.png
Input Protect Master Branch boolean	Default false	Notes (Optional) Protect the master branch in project where branching is enabled	Example true
Input Remove Project Image boolean	Default false	Notes (Optional) Indicates whether the project image should be deleted	Example false
Input Shares Translation Memory boolean	Default false	Notes (Optional) Indicates whether the project should share the account"s translation memory	Example true
Input Smart Suggest Enabled boolean	Default false	Notes (Optional) Smart Suggest, requires machine_translation_enabled	Example true
Input Smart Suggest Use Glossary boolean	Default false	Notes (Optional) Requires smart_suggest_enabled to be true	Example true
Input Smart Suggest Use Machine Translation boolean	Default false	Notes (Optional) Requires smart_suggest_enabled to be true	Example true
Input Workflow string	Default	Notes (Optional) Review Workflow	Example review
Input Zero Plural Form Enabled boolean	Default false	Notes (Optional) Displays the input fields for the "ZERO" plural form for every key as well although only some languages require the "ZERO" explicitly	Example true

---

Projects List

List projects | key: projectsList

Input	Notes
Input Account Id string	Notes Filter by Account ID
Input Connection connection / Required	Notes
Input Filters string	Notes Filter projects
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Sort By string	Notes Sort projects

---

Raw Request

Issue a raw HTTP request | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Data string	Default	Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input Form Data string Key Value List	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List	Default	Notes A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.	Example
Input Response Type string / Required	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string	Default 0	Notes The delay in milliseconds between retries.	Example
Input Timeout string	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required	Default	Notes This is the URL to call.	Example /sobjects/Account
Input Use Exponential Backoff boolean	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

Release Create

Create a release | key: releaseCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Branch string	Notes Branch used for release	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Description string	Notes Description of the release	Example My first Release
Input Distribution Id string / Required	Notes Distribution ID	Example
Input Locale Ids string	Notes List of locale ids that will be included in the release	Example abcd1234cdef1234abcd1234cdef1234,fff565db236400772368235db2c6117e
Input Platforms string	Notes List of platforms the release should support	Example android,ios

---

Release Delete

Delete a release | key: releaseDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Distribution Id string / Required	Notes Distribution ID
Input Id string / Required	Notes ID

---

Release Publish

Publish a release | key: releasePublish

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Distribution Id string / Required	Notes Distribution ID
Input Id string / Required	Notes ID

---

Release Show

Get a single release | key: releaseShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Distribution Id string / Required	Notes Distribution ID
Input Id string / Required	Notes ID

---

Release Update

Update a release | key: releaseUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Branch string	Notes Branch used for release	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Description string	Notes Description of the release	Example My first Release
Input Distribution Id string / Required	Notes Distribution ID	Example
Input Id string / Required	Notes ID	Example
Input Platforms string	Notes List of platforms the release should support	Example android,ios

---

Releases List

List releases | key: releasesList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Distribution Id string / Required	Notes Distribution ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Screenshot Create

Create a screenshot | key: screenshotCreate

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes Project ID

---

Screenshot Delete

Delete a screenshot | key: screenshotDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Screenshot Marker Create

Create a screenshot marker | key: screenshotMarkerCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Key Id string	Notes Specify the Key ID which should be highlighted on the specified screenshot	Example abcd1234abcd1234abcd1234abcd1234
Input Presentation string	Notes Presentation details of the screenshot marker in JSON format	Example { "x": 100, "y": 100, "w": 100, "h": 100 }
Input Project Id string / Required	Notes Project ID	Example
Input Screenshot Id string / Required	Notes Screenshot ID	Example

---

Screenshot Marker Delete

Delete a screenshot marker | key: screenshotMarkerDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes Project ID
Input Screenshot Id string / Required	Notes Screenshot ID

---

Screenshot Marker Show

Get a single screenshot marker | key: screenshotMarkerShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID
Input Screenshot Id string / Required	Notes Screenshot ID

---

Screenshot Marker Update

Update a screenshot marker | key: screenshotMarkerUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Key Id string	Notes Specify the Key ID which should be highlighted on the specified screenshot	Example abcd1234abcd1234abcd1234abcd1234
Input Presentation string	Notes Presentation details of the screenshot marker in JSON format	Example { "x": 100, "y": 100, "w": 100, "h": 100 }
Input Project Id string / Required	Notes Project ID	Example
Input Screenshot Id string / Required	Notes Screenshot ID	Example

---

Screenshot Markers List

List screenshot markers | key: screenshotMarkersList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Screenshot Show

Get a single screenshot | key: screenshotShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Screenshot Update

Update a screenshot | key: screenshotUpdate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Description string	Notes Description of the screenshot	Example A screenshot description
Input Filename string	Notes Screenshot file	Example /path/to/my/screenshot.png
Input Id string / Required	Notes ID	Example
Input Name string	Notes Name of the screenshot	Example A screenshot name
Input Project Id string / Required	Notes Project ID	Example

---

Screenshots List

List screenshots | key: screenshotsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Key Id string	Notes filter by key
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Search In Account

Search across projects | key: searchInAccount

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Locale Code string	Notes Locale code	Example de_DE
Input Page string	Notes Page	Example 1
Input Per Page string	Notes Number of results per page	Example 25
Input Query string	Notes Search query	Example keyword

---

Show User

Show current User | key: showUser

Input	Notes
Input Connection connection / Required	Notes

---

Space Create

Create a Space | key: spaceCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the space	Example My Android Projects

---

Space Delete

Delete Space | key: spaceDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Space Show

Get Space | key: spaceShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID

---

Space Update

Update Space | key: spaceUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Name string	Notes New name of the space	Example My Android Projects

---

Spaces List

List Spaces | key: spacesList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Spaces Projects Create

Add Project | key: spacesProjectsCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string	Notes Project ID to add or to the Space	Example a4b3c2d1
Input Space Id string / Required	Notes Space ID	Example

---

Spaces Projects Delete

Remove Project | key: spacesProjectsDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Space Id string / Required	Notes Space ID

---

Spaces Projects List

List Projects | key: spacesProjectsList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Space Id string / Required	Notes Space ID

---

Styleguide Create

Create a style guide | key: styleguideCreate

Input	Notes	Example
Input Audience string	Notes Audience description	Example customer-facing
Input Business string	Notes Description of the business	Example We are a travel site that helps customers find the best hotels and flights.
Input Company Branding string	Notes Company branding to remain consistent	Example ACME Inc. should never be translated.
Input Connection connection / Required	Notes	Example
Input Formatting string	Notes Formatting requirements and character limitations	Example Never use capital letters
Input Glossary Terms string	Notes List of terms and/or phrases that need to be translated consistently	Example Apartment, cabin, loft
Input Grammar Consistency string	Notes Formal or informal pronouns, consistent conjugation, grammatical gender	Example
Input Grammatical Person string	Notes Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural	Example first_person_singular
Input Literal Translation string	Notes Can be one of: Cultural/Conversational, Literal, Neutral	Example Neutral
Input Overall Tone string	Notes Tone requirement descriptions	Example Tone should be fun and light
Input Project Id string / Required	Notes Project ID	Example
Input Samples string	Notes Provide links to sample product pages, FAQ pages, etc	Example http://www.myexample.com/my/document/path/to/samples.pdf
Input Target Audience string	Notes Can be one of: not_specified, children, teenager, young_adults, adults, old_adults	Example teenager
Input Title string	Notes Style guide title	Example Web application style guide
Input Vocabulary Type string	Notes Can be one of: not_specified, popular, technical, fictional	Example technical

---

Styleguide Delete

Delete a style guide | key: styleguideDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Styleguide Show

Get a single style guide | key: styleguideShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Styleguide Update

Update a style guide | key: styleguideUpdate

Input	Notes	Example
Input Audience string	Notes Audience description	Example customer-facing
Input Business string	Notes Description of the business	Example We are a travel site that helps customers find the best hotels and flights.
Input Company Branding string	Notes Company branding to remain consistent	Example ACME Inc. should never be translated.
Input Connection connection / Required	Notes	Example
Input Formatting string	Notes Formatting requirements and character limitations	Example Never use capital letters
Input Glossary Terms string	Notes List of terms and/or phrases that need to be translated consistently	Example Apartment, cabin, loft
Input Grammar Consistency string	Notes Formal or informal pronouns, consistent conjugation, grammatical gender	Example
Input Grammatical Person string	Notes Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural	Example first_person_singular
Input Id string / Required	Notes ID	Example
Input Literal Translation string	Notes Can be one of: Cultural/Conversational, Literal, Neutral	Example Neutral
Input Overall Tone string	Notes Tone requirement descriptions	Example Tone should be fun and light
Input Project Id string / Required	Notes Project ID	Example
Input Samples string	Notes Provide links to sample product pages, FAQ pages, etc	Example http://www.myexample.com/my/document/path/to/samples.pdf
Input Target Audience string	Notes Can be one of: not_specified, children, teenager, young_adults, adults, old_adults	Example teenager
Input Title string	Notes Style guide title	Example Web application style guide
Input Vocabulary Type string	Notes Can be one of: not_specified, popular, technical, fictional	Example technical

---

Styleguides List

List style guides | key: styleguidesList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Tag Create

Create a tag | key: tagCreate

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the tag	Example my-feature
Input Project Id string / Required	Notes Project ID	Example

---

Tag Delete

Delete a tag | key: tagDelete

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Tag Show

Get a single tag | key: tagShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Tags List

List tags | key: tagsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Team Create

Create a Team | key: teamCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the team	Example German Translators

---

Team Delete

Delete Team | key: teamDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Team Id string / Required	Notes Team ID

---

Team Show

Get Team | key: teamShow

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Team Id string / Required	Notes Team ID

---

Team Update

Update Team | key: teamUpdate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes New name of the team	Example German Translators
Input Team Id string / Required	Notes Team ID	Example

---

Teams List

List Teams | key: teamsList

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default

---

Teams Projects Create

Add Project | key: teamsProjectsCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string	Notes Project ID to add to the Team	Example a4b3c2d1
Input Team Id string / Required	Notes Team ID	Example

---

Teams Projects Delete

Remove Project | key: teamsProjectsDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Team Id string / Required	Notes Team ID

---

Teams Spaces Create

Add Space | key: teamsSpacesCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string	Notes Space ID to add to the Team	Example a4b3c2d1
Input Team Id string / Required	Notes Team ID	Example

---

Teams Spaces Delete

Remove Space | key: teamsSpacesDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Team Id string / Required	Notes Team ID

---

Teams Users Create

Add User | key: teamsUsersCreate

Input	Notes	Example
Input Account Id string / Required	Notes Account ID	Example
Input Connection connection / Required	Notes	Example
Input Id string	Notes User ID to add to the Team	Example a4b3c2d1
Input Team Id string / Required	Notes Team ID	Example

---

Teams Users Delete

Remove User | key: teamsUsersDelete

Input	Notes
Input Account Id string / Required	Notes Account ID
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Team Id string / Required	Notes Team ID

---

Translation Create

Create a translation | key: translationCreate

Input	Default	Notes	Example
Input Autotranslate boolean	Default false	Notes Indicates whether the translation should be auto-translated	Example null
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Default	Notes	Example
Input Content string	Default	Notes Translation content	Example My translation
Input Excluded boolean	Default false	Notes Indicates whether translation is excluded	Example null
Input Key Id string	Default	Notes Key	Example abcd1234cdef1234abcd1234cdef1234
Input Locale Id string	Default	Notes Locale	Example abcd1234cdef1234abcd1234cdef1234
Input Plural Suffix string	Default	Notes Plural suffix	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Unverified boolean	Default false	Notes Indicates whether translation is unverified	Example null

---

Translation Exclude

Exclude a translation from export | key: translationExclude

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Translation Include

Revoke exclusion of a translation in export | key: translationInclude

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Translation Review

Review a translation | key: translationReview

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Translation Show

Get a single translation | key: translationShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Translation Unverify

Mark a translation as unverified | key: translationUnverify

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Translation Update

Update a translation | key: translationUpdate

Input	Default	Notes	Example
Input Autotranslate boolean	Default false	Notes Indicates whether the translation should be auto-translated	Example null
Input Branch string	Default	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Default	Notes	Example
Input Content string	Default	Notes Translation content	Example My translation
Input Excluded boolean	Default false	Notes Indicates whether translation is excluded	Example null
Input Id string / Required	Default	Notes ID	Example
Input Plural Suffix string	Default	Notes Plural suffix	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Unverified boolean	Default false	Notes Indicates whether translation is unverified	Example null

---

Translation Verify

Verify a translation | key: translationVerify

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Id string / Required	Notes ID	Example
Input Project Id string / Required	Notes Project ID	Example

---

Translations By Key

List translations by key | key: translationsByKey

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Key Id string / Required	Notes Translation Key ID
Input Order string	Notes Order direction
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Q string	Notes Specify a query to find translations by content (including wildcards)
Input Sort string	Notes Sort criteria

---

Translations By Locale

List translations by locale | key: translationsByLocale

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Locale Id string / Required	Notes Locale ID
Input Order string	Notes Order direction
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Q string	Notes Specify a query to find translations by content (including wildcards)
Input Sort string	Notes Sort criteria

---

Translations Exclude Collection

Set exclude from export flag on translations selected by query | key: translationsExcludeCollection

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Order string	Notes Order direction	Example desc
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%20verified:true%20tags:feature,center
Input Sort string	Notes Sort criteria	Example updated_at

---

Translations Include Collection

Remove exlude from import flag from translations selected by query | key: translationsIncludeCollection

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Order string	Notes Order direction	Example desc
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%20verified:true%20tags:feature,center
Input Sort string	Notes Sort criteria	Example updated_at

---

Translations List

List all translations | key: translationsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Order string	Notes Order direction
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Q string	Notes Specify a query to find translations by content (including wildcards)
Input Sort string	Notes Sort criteria

---

Translations Review Collection

Review translations selected by query | key: translationsReviewCollection

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%reviewed:false%20tags:feature,center

---

Translations Search

Search translations | key: translationsSearch

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Order string	Notes Order direction	Example desc
Input Page string	Notes Page number	Example
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default	Example
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center
Input Sort string	Notes Sort criteria	Example updated_at

---

Translations Unverify Collection

Mark translations selected by query as unverified | key: translationsUnverifyCollection

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Order string	Notes Order direction	Example desc
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%20verified:true%20tags:feature,center
Input Sort string	Notes Sort criteria	Example updated_at

---

Translations Verify Collection

Verify translations selected by query | key: translationsVerifyCollection

Input	Notes	Example
Input Branch string	Notes specify the branch to use	Example my-feature-branch
Input Connection connection / Required	Notes	Example
Input Locale Id string	Notes specify the locale of the translations to be verified	Example fc2f11dd6a658fa9652f6f0a9ebee688
Input Project Id string / Required	Notes Project ID	Example
Input Q string	Notes Specify a query to find translations by content (including wildcards)	Example PhraseApp*%20unverified:true%20tags:feature,center

---

Upload Create

Upload a new file | key: uploadCreate

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes Project ID

---

Upload Show

View upload details | key: uploadShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Uploads List

List uploads | key: uploadsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Variable Create

Create a variable | key: variableCreate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes Name of the variable	Example MY_VARIABLE
Input Project Id string / Required	Notes Project ID	Example
Input Value string	Notes Value of the variable	Example Hello World

---

Variable Delete

Delete a variable | key: variableDelete

Input	Notes
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Variable Show

Get a single variable | key: variableShow

Input	Notes
Input Connection connection / Required	Notes
Input Name string / Required	Notes name
Input Project Id string / Required	Notes Project ID

---

Variable Update

Update a variable | key: variableUpdate

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes name	Example
Input Name string	Notes Name of the variable	Example MY_VARIABLE
Input Project Id string / Required	Notes Project ID	Example
Input Value string	Notes Value of the variable	Example Hello World

---

Variables List

List variables | key: variablesList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---

Version Show

Get a single version | key: versionShow

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID
Input Translation Id string / Required	Notes Translation ID

---

Versions List

List all versions | key: versionsList

Input	Notes
Input Branch string	Notes specify the branch to use
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID
Input Translation Id string / Required	Notes Translation ID

---

Webhook Create

Create a webhook | key: webhookCreate

Input	Default	Notes	Example
Input Active boolean	Default false	Notes Whether webhook is active or inactive	Example null
Input Callback Url string	Default	Notes Callback URL to send requests to	Example http://example.com/hooks/phraseapp-notifications
Input Connection connection / Required	Default	Notes	Example
Input Description string	Default	Notes Webhook description	Example My webhook for chat notifications
Input Events string	Default	Notes List of event names to trigger the webhook (separated by comma)	Example locales:create,translations:update
Input Include Branches boolean	Default false	Notes If enabled, webhook will also be triggered for events from branches of the project specified	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Secret string	Default	Notes Webhook secret used to calculate signature	Example secr3t

---

Webhook Delete

Delete a webhook | key: webhookDelete

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Webhook Show

Get a single webhook | key: webhookShow

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Webhook Test

Test a webhook | key: webhookTest

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes ID
Input Project Id string / Required	Notes Project ID

---

Webhook Update

Update a webhook | key: webhookUpdate

Input	Default	Notes	Example
Input Active boolean	Default false	Notes Whether webhook is active or inactive	Example null
Input Callback Url string	Default	Notes Callback URL to send requests to	Example http://example.com/hooks/phraseapp-notifications
Input Connection connection / Required	Default	Notes	Example
Input Description string	Default	Notes Webhook description	Example My webhook for chat notifications
Input Events string	Default	Notes List of event names to trigger the webhook (separated by comma)	Example locales:create,translations:update
Input Id string / Required	Default	Notes ID	Example
Input Include Branches boolean	Default false	Notes If enabled, webhook will also be triggered for events from branches of the project specified	Example null
Input Project Id string / Required	Default	Notes Project ID	Example
Input Secret string	Default	Notes Webhook secret used to calculate signature	Example secr3t

---

Webhooks List

List webhooks | key: webhooksList

Input	Notes
Input Connection connection / Required	Notes
Input Page string	Notes Page number
Input Per Page string	Notes allows you to specify a page size up to 100 items, 25 by default
Input Project Id string / Required	Notes Project ID

---