---
canonical_url: "https://docs.composio.dev/toolkits/phrase"
markdown_url: "https://docs.composio.dev/toolkits/phrase.md"
product: "platform"
version: null
last_updated: null
---

# Phrase

Phrase Strings provides APIs for software localization projects, locales, keys, translations, files, jobs, and automation.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 302
- **Triggers:** 0
- **Slug:** `PHRASE`
- **Version:** 00000000_00

## Tools

### List automation events for an account

**Slug:** `PHRASE_ACCOUNT_AUTOMATION_EVENTS_LIST`

Returns the run history across all automations in the account, newest-first. Use `automation_id` to narrow results to a single automation. Use `project_id` or `project_ids` to narrow by project. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `state` | string ("success" | "failure" | "in_progress") | No | Provider state value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `project_id` | string | No | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `project_ids` | array | No | Provider project_ids value. |
| `triggered_by` | string ("manual" | "schedule" | "upload" | "upload_batch") | No | Provider triggered_by value. |
| `automation_id` | string | No | Provider automation_id value. |
| `created_after` | string | No | Provider created_after value. |
| `created_before` | string | No | Provider created_before value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List locales used in account

**Slug:** `PHRASE_ACCOUNT_LOCALES`

List all locales unique by locale code used across all projects within an account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single account

**Slug:** `PHRASE_ACCOUNT_SHOW`

Get details on a single account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an authorization

**Slug:** `PHRASE_AUTHORIZATION_CREATE`

Create a new authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an authorization

**Slug:** `PHRASE_AUTHORIZATION_DELETE`

Delete an existing authorization. API calls using that token will stop working. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single authorization

**Slug:** `PHRASE_AUTHORIZATION_SHOW`

Get details on a single authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List authorizations

**Slug:** `PHRASE_AUTHORIZATIONS_LIST`

List all your authorizations. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an authorization

**Slug:** `PHRASE_AUTHORIZATION_UPDATE`

Update an existing authorization. This operation requires Basic authentication with email and password and is unavailable on this API-key toolkit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Activate an automation

**Slug:** `PHRASE_AUTOMATION_ACTIVATE`

Activate an automation. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an automation

**Slug:** `PHRASE_AUTOMATION_CREATE`

Create a new automation. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivate an automation

**Slug:** `PHRASE_AUTOMATION_DEACTIVATE`

Deactivate an automation. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy automation

**Slug:** `PHRASE_AUTOMATION_DELETE`

Destroy an automation of an account. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List events for an automation

**Slug:** `PHRASE_AUTOMATION_EVENTS_LIST`

Returns the run history for a specific automation, newest-first. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `state` | string ("success" | "failure" | "in_progress") | No | Provider state value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `project_id` | string | No | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `project_ids` | array | No | Provider project_ids value. |
| `triggered_by` | string ("manual" | "schedule" | "upload" | "upload_batch") | No | Provider triggered_by value. |
| `automation_id` | string | Yes | Provider automation_id value. |
| `created_after` | string | No | Provider created_after value. |
| `created_before` | string | No | Provider created_before value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single automation

**Slug:** `PHRASE_AUTOMATION_SHOW`

Get details of a single automation. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List automations

**Slug:** `PHRASE_AUTOMATIONS_LIST`

List all automations for an account. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger an automation

**Slug:** `PHRASE_AUTOMATION_TRIGGER`

Trigger an automation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an automation

**Slug:** `PHRASE_AUTOMATION_UPDATE`

Update an existing automation. For feature availability, see Jobs (Strings).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `automation_id` | string | Yes | Provider automation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a blocked key

**Slug:** `PHRASE_BLOCKED_KEY_CREATE`

Create a new blocked-key rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a blocked key

**Slug:** `PHRASE_BLOCKED_KEY_DELETE`

Delete an existing blocked-key rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a blocked key

**Slug:** `PHRASE_BLOCKED_KEY_SHOW`

Get a single blocked-key rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List blocked keys

**Slug:** `PHRASE_BLOCKED_KEYS_LIST`

List all blocked-key rules for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a blocked key

**Slug:** `PHRASE_BLOCKED_KEY_UPDATE`

Update an existing blocked-key rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compare branches

**Slug:** `PHRASE_BRANCH_COMPARE`

Compare branch with main branch. *Note: Comparing a branch may take several minutes depending on the project size. Consider using the `POST /compare` endpoint for creating comparison asynchronously.*

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |
| `query_name` | string | No | Provider name value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create comparison (async.)

**Slug:** `PHRASE_BRANCH_COMPARISON_CREATE`

Create a branch comparison asynchronously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a branch

**Slug:** `PHRASE_BRANCH_CREATE`

Create a new branch. Branch project provisioning runs asynchronously, so the newly created branch is returned in a transitional state (typically `creating_branch`) and only reaches `success` once the underlying project has been set up. Poll the branch resource until its `state` becomes `success` before performing further operations on it. Requires the Branching feature to be enabled on the account. *Note: Creating a new branch may take several minutes depending on the project size.*

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a branch

**Slug:** `PHRASE_BRANCH_DELETE`

Delete an existing branch. A branch cannot be deleted while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow deletion (for example, while a merge or sync is in progress) is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List branches

**Slug:** `PHRASE_BRANCHES_LIST`

List all branches of the current project. Requires the Branching feature to be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge a branch

**Slug:** `PHRASE_BRANCH_MERGE`

Merge an existing branch back into its base branch. The merge runs asynchronously. The branch transitions to `merging_branch` and settles in `merged`, `merge_error`, or `merge_conflict` once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. A branch cannot be merged while it still has open jobs or open translation orders attached to its branch project — in that case the request is rejected with `409 Conflict`. A branch whose current `state` does not allow a merge is rejected with `422 Unprocessable Entity`. Requires the Branching feature to be enabled on the account. *Note: Merging a branch may take several minutes depending on diff size.*

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single branch

**Slug:** `PHRASE_BRANCH_SHOW`

Get details on a single branch for a given project. Requires the Branching feature to be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sync a branch

**Slug:** `PHRASE_BRANCH_SYNC`

Pull changes from the base branch into this branch, applying the chosen conflict-resolution strategy. The sync runs asynchronously. The branch transitions to `syncing_branch` and settles back into `success` (or `merge_conflict` / `branch_error`) once the background job completes; the response body for this request is empty. Poll the branch resource to observe the final state. Only branches created with the newer branching system can be synced. Requests against branches from the older system, or against branches whose current state does not allow a sync, are rejected with `422 Unprocessable Entity` and an empty body. Requires the Branching feature to be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a branch

**Slug:** `PHRASE_BRANCH_UPDATE`

Update an existing branch. Only the branch name can be changed. Requires the Branching feature to be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Dismiss a check issue

**Slug:** `PHRASE_CHECK_ISSUE_DISMISS`

**Note:** The Checks API is still in development and might change in subsequent releases. Mark a check issue as dismissed so it no longer appears on the list of active check issues.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List check issues

**Slug:** `PHRASE_CHECK_ISSUES_LIST`

**Note:** The Checks API is still in development and might change in subsequent releases. List check issues for the given project. Results can be filtered by locale, check name, and state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `state` | string ("active" | "solved" | "dismissed" | "all") | No | Provider state value. |
| `per_page` | integer | No | Provider per_page value. |
| `locale_ids` | array | No | Provider locale_ids value. |
| `project_id` | string | Yes | Provider project_id value. |
| `check_names` | array | No | Provider check_names value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `created_since` | string | No | Provider created_since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a comment

**Slug:** `PHRASE_COMMENT_CREATE`

Create a new comment for a key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a comment

**Slug:** `PHRASE_COMMENT_DELETE`

Delete an existing comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if comment is read

**Slug:** `PHRASE_COMMENT_MARK_CHECK`

Check if comment was marked as read. Returns 204 if read, 404 if unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a comment as read

**Slug:** `PHRASE_COMMENT_MARK_READ`

Mark a comment as read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a comment as unread

**Slug:** `PHRASE_COMMENT_MARK_UNREAD`

Mark a comment as unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single comment

**Slug:** `PHRASE_COMMENT_SHOW`

Get details on a single comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List comments

**Slug:** `PHRASE_COMMENTS_LIST`

List all comments for a key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `order` | string ("asc" | "desc") | No | Provider order value. |
| `query` | string | No | Provider query value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `filters` | array | No | Provider filters value. |
| `per_page` | integer | No | Provider per_page value. |
| `locale_ids` | array | No | Provider locale_ids value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a comment

**Slug:** `PHRASE_COMMENT_UPDATE`

Update an existing comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `key_id` | string | Yes | Provider key_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Key

**Slug:** `PHRASE_CREATE_KEY`

Create a translation key in a Phrase Strings project with the documented key attributes, optionally including default-locale content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique key name. |
| `tags` | array | No | Tags to associate with the key; sent to Phrase as comma-separated text. |
| `branch` | string | No | Project branch in which to create the key; omit for the default branch. |
| `plural` | boolean | No | Whether the key supports plural forms. |
| `data_type` | string ("string" | "number" | "boolean" | "array" | "markdown") | No | Value type represented by the key. |
| `project_id` | string | Yes | ID of the project that will contain the key. |
| `screenshot` | string | No | Deprecated screenshot/image value. Prefer the Phrase Screenshots endpoint. |
| `description` | string | No | Context for translators about where or how the key is used. |
| `name_plural` | string | No | Plural key name used by formats such as Gettext. |
| `unformatted` | boolean | No | Whether exports should treat the key as unformatted. |
| `autotranslate` | boolean | No | Whether to autotranslate other locales from default_translation_content. |
| `original_file` | string | No | Original file attribute used by formats such as XLIFF. |
| `custom_metadata` | object | No | Custom metadata property name and value pairs to associate with the key. |
| `format_value_type` | string | No | Value type override used when exporting the key. |
| `remove_screenshot` | boolean | No | Deprecated flag indicating whether to delete the legacy screenshot. Prefer the Phrase Screenshots endpoint. |
| `use_ordinal_rules` | boolean | No | Whether the key uses ordinal pluralization rules. |
| `xml_space_preserve` | boolean | No | Whether XML-based exports should preserve whitespace for this key. |
| `excluded_in_locales` | array | No | Locale IDs or names in which this key should be excluded from exports. |
| `localized_format_key` | string | No | NSStringLocalizedFormatKey attribute used in .stringsdict format. |
| `max_characters_allowed` | integer | No | Maximum number of characters allowed in translations for this key. |
| `localized_format_string` | string | No | NSStringLocalizedFormatKey attribute used in .stringsdict format. |
| `default_translation_content` | string | No | Content to create immediately in the project's default locale. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Locale

**Slug:** `PHRASE_CREATE_LOCALE`

Add a locale to a Phrase Strings project using a unique locale-style name and an ISO locale code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rtl` | boolean | No | Whether this is a right-to-left locale. |
| `code` | string | Yes | Locale ISO code, such as de-DE. Unlike name, Phrase permits multiple locales in one project to share the same code. |
| `main` | boolean | No | Whether this is a main locale in Phrase's Verification System. This setting requires that feature to be available. |
| `name` | string | Yes | Unique locale identifier within the project. Use a locale-style value such as en-US, not an arbitrary display label; Phrase rejected 'English (United States)' during live probing. |
| `branch` | string | No | Project branch in which to create the locale; omit for the default branch. |
| `default` | boolean | No | Whether to make this the project's default locale, replacing the previous default locale. |
| `project_id` | string | Yes | ID of the project that will contain the locale. |
| `autotranslate` | boolean | No | Whether to fetch translations automatically immediately after creation. |
| `source_locale_id` | string | No | Source locale ID or name. Phrase recommends using the locale ID when available. |
| `fallback_locale_id` | string | No | Fallback locale ID or name to use for empty translations. |
| `language_ai_profile` | string | No | ID of the Language AI profile to use for this locale. |
| `unverify_new_translations` | boolean | No | Whether new translations for this locale are marked as unverified. This requires the Advanced Workflows feature. |
| `unverify_on_source_changes` | boolean | No | Whether source-language changes mark this locale's translations as unverified. |
| `unverify_updated_translations` | boolean | No | Whether updated translations for this locale are marked as unverified. This requires the Advanced Workflows feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `PHRASE_CREATE_PROJECT`

Create a Phrase Strings localization project in an accessible account. With source_project_id, Phrase asynchronously clones locales, keys, translations, and source settings after responding; explicit settings override inherited settings except shares_translation_memory. Without cloning, shares_translation_memory defaults to true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new project. |
| `media` | string | No | Main technology stack. Phrase uses it to suggest placeholder styles; predefined and custom values are accepted. |
| `tm_ids` | array | No | TMS translation-memory IDs for AI translation reference content. |
| `workflow` | string | No | Review workflow for the project. |
| `account_id` | string | No | Account ID in which to create the project; required by Phrase when the connected user belongs to multiple accounts. |
| `main_format` | string | No | Default locale-download format specified by its Phrase API extension name, such as json or yml. |
| `cldr_version` | string | No | CLDR plural-rule version, such as legacy or cldr48. |
| `project_image` | string | No | Project image value accepted by Phrase's documented binary string field. |
| `term_base_ids` | array | No | TMS term-base IDs used by the AI translation agent. |
| `default_encoding` | string ("UTF-8" | "UTF-16" | "UTF-16BE" | "UTF-16LE" | "ISO-8859-1") | No | Default encoding used for file uploads. |
| `enable_branching` | boolean | No | Whether to enable project branches. |
| `point_of_contact` | string | No | User ID of the project's point of contact. |
| `source_project_id` | string | No | Source project ID to clone. Phrase asynchronously copies locales, keys, translations, and settings after returning; explicit request settings override inherited settings except shares_translation_memory. |
| `placeholder_styles` | array | No | Placeholder styles enabled for detecting variables in translation keys. |
| `job_locking_enabled` | boolean | No | Whether translations lock when a job enters review. |
| `remove_project_image` | boolean | No | Whether to remove the project image. |
| `autotranslate_enabled` | boolean | No | Whether to enable Autopilot; requires machine translation support. |
| `protect_master_branch` | boolean | No | Whether to protect the master branch when branching is enabled. |
| `smart_suggest_enabled` | boolean | No | Whether Smart Suggest is enabled; Phrase defaults it to true. |
| `autocomplete_job_enabled` | boolean | No | Whether new keys and locales are added to active jobs automatically. |
| `zero_plural_form_enabled` | boolean | No | Whether to display ZERO plural-form inputs for every key. |
| `enable_icu_message_format` | boolean | No | Whether to validate and highlight ICU messages. |
| `shares_translation_memory` | boolean | No | Whether to share the account translation memory. Defaults to true for a new project; a cloned project inherits this setting from its source. |
| `smart_suggest_use_glossary` | boolean | No | Whether Smart Suggest uses the glossary; Phrase defaults it to true. |
| `machine_translation_enabled` | boolean | No | Whether to enable machine-translation support. |
| `autotranslate_check_new_locales` | boolean | No | Whether Autopilot processes newly created locales. |
| `autotranslate_check_new_uploads` | boolean | No | Whether Autopilot processes new uploads. |
| `translation_keys_sort_collation` | string ("general_ci" | "unicode_ci") | No | Collation for alphabetical translation-key sorting; defaults to unicode_ci. |
| `autotranslate_mark_as_unverified` | boolean | No | Whether Autopilot marks generated translations as unverified. |
| `autotranslate_use_translation_memory` | boolean | No | Whether Autopilot uses translation memory. |
| `fallback_for_unverified_translations` | boolean | No | Whether exports use fallback-locale content for unverified translations. |
| `autotranslate_use_machine_translation` | boolean | No | Whether Autopilot uses machine translation. |
| `smart_suggest_use_machine_translation` | boolean | No | Whether Smart Suggest uses machine translation; Phrase defaults it to true. |
| `autotranslate_check_new_translation_keys` | boolean | No | Whether Autopilot processes newly created translation keys. |
| `autotranslate_overwrite_unverified_translations` | boolean | No | Whether Autopilot may overwrite unverified translations. |
| `enable_all_data_type_translation_keys_for_translators` | boolean | No | Whether translators may edit translation keys of every data type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Translation

**Slug:** `PHRASE_CREATE_TRANSLATION`

Create content for one key and locale in a Phrase Strings project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Project branch in which to create the translation; omit for the default branch. |
| `key_id` | string | Yes | Required ID of the key to translate. Phrase's live API rejects creation when this field is omitted. |
| `content` | string | No | Translation content to store. |
| `excluded` | boolean | No | Whether to exclude the translation from exports. |
| `reviewed` | boolean | No | Whether to create the translation as reviewed when the project's review workflow is enabled. |
| `locale_id` | string | Yes | Required ID or name of the locale for the translation; prefer the locale ID. Phrase's live API rejects creation when this field is omitted. |
| `project_id` | string | Yes | ID of the project containing the key and locale. |
| `unverified` | boolean | No | Whether to create the translation as unverified. This requires the Phrase Advanced Workflows feature. |
| `minor_change` | boolean | No | Whether this edit should avoid triggering downstream re-verification of linked-locale translations. |
| `autotranslate` | boolean | No | Whether Phrase should auto-translate the translation. Phrase returns 422 for a non-default locale or a project without Autopilot enabled. |
| `plural_suffix` | string ("zero" | "one" | "two" | "few" | "many" | "other") | No | Plural form; required when the key is pluralized. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy property

**Slug:** `PHRASE_CUSTOM_METADATA_PROPERTIES_DELETE`

Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List properties

**Slug:** `PHRASE_CUSTOM_METADATA_PROPERTIES_LIST`

List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `sort` | string | No | Provider sort value. |
| `order` | string | No | Provider order value. |
| `per_page` | integer | No | Provider per_page value. |
| `data_type` | string ("boolean" | "date" | "link" | "multi_select" | "number" | "single_select" | "string" | "text") | No | data type of the property |
| `account_id` | string | Yes | Provider account_id value. |
| `project_id` | string | No | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a property

**Slug:** `PHRASE_CUSTOM_METADATA_PROPERTY_CREATE`

Create a new custom metadata property.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single property

**Slug:** `PHRASE_CUSTOM_METADATA_PROPERTY_SHOW`

Get details of a single custom property.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a property

**Slug:** `PHRASE_CUSTOM_METADATA_PROPERTY_UPDATE`

Update an existing custom metadata property.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Key

**Slug:** `PHRASE_DELETE_KEY`

Delete an existing Phrase Strings key from a project or project branch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Project branch containing the key; omit for the default branch. |
| `key_id` | string | Yes | ID of the key to delete. |
| `project_id` | string | Yes | ID of the project containing the key to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Locale

**Slug:** `PHRASE_DELETE_LOCALE`

Delete an explicitly selected locale from a Phrase Strings project or project branch.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Project branch containing the locale; omit for the default branch. |
| `locale_id` | string | Yes | ID or name of the locale to delete. |
| `project_id` | string | Yes | ID of the project containing the locale to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `PHRASE_DELETE_PROJECT`

Delete an explicitly selected Phrase Strings project. Phrase also removes associated repository syncs and OTA distributions and dispatches a project:delete event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | ID of the project to delete. Phrase also removes associated repository syncs and OTA distributions and dispatches a project:delete event. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a distribution

**Slug:** `PHRASE_DISTRIBUTION_CREATE`

Create a new distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a distribution

**Slug:** `PHRASE_DISTRIBUTION_DELETE`

Delete an existing distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single distribution

**Slug:** `PHRASE_DISTRIBUTION_SHOW`

Get details on a single distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List distributions

**Slug:** `PHRASE_DISTRIBUTIONS_LIST`

List all distributions for the given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a distribution

**Slug:** `PHRASE_DISTRIBUTION_UPDATE`

Update an existing distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete document

**Slug:** `PHRASE_DOCUMENT_DELETE`

Permanently deletes a document and all of its associated translation segments from the project. Use this when you want to remove a document that is no longer needed; the deletion cannot be reversed and all associated segments will be lost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List documents

**Slug:** `PHRASE_DOCUMENTS_LIST`

Returns all documents in a project that the authenticated user has read access to. A Document is a source file — an HTML or DOCX file — that has been uploaded to Phrase Strings and whose content is segmented into translation keys for localization. Use this endpoint to enumerate documents before downloading, previewing, or triggering translation workflows for individual files. The q parameter performs a prefix match on the document name (case-insensitive). For example, passing q=invoice returns documents whose names begin with "invoice" but not documents containing "invoice" elsewhere in the name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach the Figma attachment to a key

**Slug:** `PHRASE_FIGMA_ATTACHMENT_ATTACH_TO_KEY`

Attach the Figma attachment to a key

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `figma_attachment_id` | string | Yes | Provider figma_attachment_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Figma attachment

**Slug:** `PHRASE_FIGMA_ATTACHMENT_CREATE`

Create a new Figma attachment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Figma attachment

**Slug:** `PHRASE_FIGMA_ATTACHMENT_DELETE`

Delete an existing Figma attachment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach the Figma attachment from a key

**Slug:** `PHRASE_FIGMA_ATTACHMENT_DETACH_FROM_KEY`

Detach the Figma attachment from a key

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `figma_attachment_id` | string | Yes | Provider figma_attachment_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single Figma attachment

**Slug:** `PHRASE_FIGMA_ATTACHMENT_SHOW`

Get details on a single Figma attachment for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Figma attachments

**Slug:** `PHRASE_FIGMA_ATTACHMENTS_LIST`

List all Figma attachments for the given project

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a Figma attachment

**Slug:** `PHRASE_FIGMA_ATTACHMENT_UPDATE`

Update an existing Figma attachment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List formats

**Slug:** `PHRASE_FORMATS_LIST`

Returns all file formats that Phrase Strings supports. Use the api_name value from each format as the file_format parameter when uploading or downloading locale files. Not every format supports both directions: check the importable and exportable fields before using a format in a workflow. This endpoint does not require authentication and is not subject to rate limiting.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `PHRASE_GET_CURRENT_USER`

Return the Phrase Strings user represented by the connected access token.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List term bases

**Slug:** `PHRASE_GLOSSARIES_LIST`

List all term bases (previously: glossaries) the current user has access to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a term base

**Slug:** `PHRASE_GLOSSARY_CREATE`

Create a new term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a term base

**Slug:** `PHRASE_GLOSSARY_DELETE`

Delete an existing term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single term base

**Slug:** `PHRASE_GLOSSARY_SHOW`

Get details on a single term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a term

**Slug:** `PHRASE_GLOSSARY_TERM_CREATE`

Create a new term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a term

**Slug:** `PHRASE_GLOSSARY_TERM_DELETE`

Delete an existing term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single term

**Slug:** `PHRASE_GLOSSARY_TERM_SHOW`

Get details for a single term in the term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List terms

**Slug:** `PHRASE_GLOSSARY_TERMS_LIST`

List all terms in term bases (previously: glossary) that the current user has access to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a translation for a term

**Slug:** `PHRASE_GLOSSARY_TERM_TRANSLATION_CREATE`

Create a new translation for a term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `term_id` | string | Yes | Provider term_id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a translation for a term

**Slug:** `PHRASE_GLOSSARY_TERM_TRANSLATION_DELETE`

Delete an existing translation of a term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `term_id` | string | Yes | Provider term_id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a translation for a term

**Slug:** `PHRASE_GLOSSARY_TERM_TRANSLATION_UPDATE`

Update an existing translation for a term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `term_id` | string | Yes | Provider term_id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a term

**Slug:** `PHRASE_GLOSSARY_TERM_UPDATE`

Update an existing term in a term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `glossary_id` | string | Yes | Provider glossary_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a term base

**Slug:** `PHRASE_GLOSSARY_UPDATE`

Update an existing term base (previously: glossary).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Build ICU skeletons

**Slug:** `PHRASE_ICU_SKELETON`

Generates ICU (International Components for Unicode) message format skeletons for a given source string across one or more locales. An ICU skeleton strips the literal text from a pluralized or select message while preserving its structural rules — argument names, plural categories, select cases, and ordinal forms — adjusted to the pluralization rules of each requested locale. Use this endpoint to normalize translation templates before importing them into locale files, or to validate that a source string carries the plural forms required by a target language. Either `content` or `id` must be provided — supplying both or neither returns 400. When `id` is used and the referenced translation does not exist, the endpoint returns 404. When the source string is not valid ICU message format syntax, the endpoint returns 422 with an `error` field describing the parse failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new invitation

**Slug:** `PHRASE_INVITATION_CREATE`

Invite a person to an account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an invitation

**Slug:** `PHRASE_INVITATION_DELETE`

Delete an existing invitation (must not be accepted yet). Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resend an invitation

**Slug:** `PHRASE_INVITATION_RESEND`

Resend the invitation email (must not be accepted yet). Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single invitation

**Slug:** `PHRASE_INVITATION_SHOW`

Get details on a single invitation. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List invitations

**Slug:** `PHRASE_INVITATIONS_LIST`

List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an invitation

**Slug:** `PHRASE_INVITATION_UPDATE`

Update an existing invitation (must not be accepted yet). The `email` cannot be updated. Developers and translators need `project_ids` and `locale_ids` assigned to access them. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a member's invitation access

**Slug:** `PHRASE_INVITATION_UPDATE_SETTINGS`

Update member's settings in the invitations. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job annotation

**Slug:** `PHRASE_JOB_ANNOTATION_DELETE`

Delete an annotation for a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job annotations

**Slug:** `PHRASE_JOB_ANNOTATIONS_LIST`

Retrieve a list of annotations for a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create/Update a job annotation

**Slug:** `PHRASE_JOB_ANNOTATION_UPDATE`

Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a job comment

**Slug:** `PHRASE_JOB_COMMENT_CREATE`

Create a new comment for a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job comment

**Slug:** `PHRASE_JOB_COMMENT_DELETE`

Delete an existing job comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single job comment

**Slug:** `PHRASE_JOB_COMMENT_SHOW`

Get details on a single job comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job comments

**Slug:** `PHRASE_JOB_COMMENTS_LIST`

List all comments for a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string | No | Provider order value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a job comment

**Slug:** `PHRASE_JOB_COMMENT_UPDATE`

Update an existing job comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete a job

**Slug:** `PHRASE_JOB_COMPLETE`

Mark a job as completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a job

**Slug:** `PHRASE_JOB_CREATE`

Create a new job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job

**Slug:** `PHRASE_JOB_DELETE`

Delete an existing job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add keys to job

**Slug:** `PHRASE_JOB_KEYS_CREATE`

Add multiple keys to a existing job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove keys from job

**Slug:** `PHRASE_JOB_KEYS_DELETE`

Remove multiple keys from existing job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job locale annotation

**Slug:** `PHRASE_JOB_LOCALE_ANNOTATION_DELETE`

Delete an annotation for a job locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_locale_id` | string | Yes | Provider job_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job locale annotations

**Slug:** `PHRASE_JOB_LOCALE_ANNOTATIONS_LIST`

Retrieve a list of annotations for a job locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_locale_id` | string | Yes | Provider job_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create/Update a job locale annotation

**Slug:** `PHRASE_JOB_LOCALE_ANNOTATION_UPDATE`

Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_locale_id` | string | Yes | Provider job_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete a job locale

**Slug:** `PHRASE_JOB_LOCALE_COMPLETE`

Mark a job locale as completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a job locale

**Slug:** `PHRASE_JOB_LOCALE_COMPLETE_REVIEW`

Mark job locale as reviewed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove a target locale from a job

**Slug:** `PHRASE_JOB_LOCALE_DELETE`

Removes a target locale from a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reopen a job locale

**Slug:** `PHRASE_JOB_LOCALE_REOPEN`

Mark a job locale as uncompleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a target locale to a job

**Slug:** `PHRASE_JOB_LOCALES_CREATE`

Adds a target locale to a job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Show single job target locale

**Slug:** `PHRASE_JOB_LOCALE_SHOW`

Get a single target locale for a given job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `include_annotations` | boolean | No | Provider include_annotations value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job target locales

**Slug:** `PHRASE_JOB_LOCALES_LIST`

List all target locales for a given job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `job_id` | string | Yes | Provider job_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `include_annotations` | boolean | No | Provider include_annotations value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a job target locale

**Slug:** `PHRASE_JOB_LOCALE_UPDATE`

Update an existing job target locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `job_id` | string | Yes | Provider job_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lock a job

**Slug:** `PHRASE_JOB_LOCK`

If you are the job owner, you may lock a job using this API request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reopen a job

**Slug:** `PHRASE_JOB_REOPEN`

Mark a job as uncompleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List account jobs

**Slug:** `PHRASE_JOBS_BY_ACCOUNT`

List all jobs for the given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `state` | string | No | Provider state value. |
| `owned_by` | string | No | Provider owned_by value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `assigned_to` | string | No | Provider assigned_to value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `updated_since` | string | No | Provider updated_since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single job

**Slug:** `PHRASE_JOB_SHOW`

Get details on a single job for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `include_annotations` | boolean | No | Provider include_annotations value. |
| `omit_translation_keys` | boolean | No | Provider omit_translation_keys value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List jobs

**Slug:** `PHRASE_JOBS_LIST`

List all jobs for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `state` | string | No | Provider state value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | No | Provider key_id value. |
| `states` | array | No | Provider states value. |
| `owned_by` | string | No | Provider owned_by value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `assigned_to` | string | No | Provider assigned_to value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `updated_since` | string | No | Provider updated_since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start a job

**Slug:** `PHRASE_JOB_START`

Starts an existing job in state draft.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a job template

**Slug:** `PHRASE_JOB_TEMPLATE_CREATE`

Create a new job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job template

**Slug:** `PHRASE_JOB_TEMPLATE_DELETE`

Delete an existing job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a job template locale

**Slug:** `PHRASE_JOB_TEMPLATE_LOCALE_DELETE`

Delete an existing job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a job template locale

**Slug:** `PHRASE_JOB_TEMPLATE_LOCALES_CREATE`

Create a new job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single job template locale

**Slug:** `PHRASE_JOB_TEMPLATE_LOCALE_SHOW`

Get a single job template locale for a given job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job template locales

**Slug:** `PHRASE_JOB_TEMPLATE_LOCALES_LIST`

List all job template locales for a given job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `job_template_id` | string | Yes | Provider job_template_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a job template locale

**Slug:** `PHRASE_JOB_TEMPLATE_LOCALE_UPDATE`

Update an existing job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job templates

**Slug:** `PHRASE_JOB_TEMPLATES_LIST`

List all job templates for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single job template

**Slug:** `PHRASE_JOB_TEMPLATES_SHOW`

Get details on a single job template for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a job template

**Slug:** `PHRASE_JOB_TEMPLATE_UPDATE`

Update an existing job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlock a job

**Slug:** `PHRASE_JOB_UNLOCK`

If you are the job owner, you may unlock a locked job using this API request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a job

**Slug:** `PHRASE_JOB_UPDATE`

Update an existing job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List format annotations for a key

**Slug:** `PHRASE_KEY_FORMAT_ANNOTATIONS_LIST`

Returns the format annotations stored on a translation key. Format annotations capture file-format data recorded when the key was imported — for example, an ARB placeholder block or an XLIFF note. Results are limited to 1,000 entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch unlink child keys from a parent key

**Slug:** `PHRASE_KEY_LINKS_BATCH_DESTROY`

Removes one or more child keys from a parent key's linked-key group, or dissolves the entire group by setting unlink_parent to true. Use this when you need to detach specific child keys from a shared translation source, or to fully break apart a linked-key group so each key manages its own translations independently. When child keys are unlinked, their translations are updated with a copy of the parent's current content (strategy keep_content, the default) or cleared (strategy remove_content). This operation is only available on main projects. It returns 422 when a child key in `child_key_ids` is not currently linked to the parent, or when a translation update fails while unlinking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | No | Optional JSON request body. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link child keys to a parent key

**Slug:** `PHRASE_KEY_LINKS_CREATE`

Designates a translation key as a parent and links one or more child keys to it. Once linked, child keys receive a special reference marker as their translation content, signalling that their translations are derived from the parent. Use this when you want to group related keys — for example, a short label and its long-form variant — so translators see them in context together. Pass an empty child_key_ids array to mark the key as a parent without linking any children yet. Both the parent key and every child key must belong to the main project; branch keys cannot participate in key links. A child key can have at most one parent at a time; attempting to link a child that already has a parent returns a 422 error with code CHILD_IS_ALREADY_LINKED. Parent and child key plurality must match — linking a plural child to a non-plural parent (or vice versa) also returns a 422.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink a child key from a parent key

**Slug:** `PHRASE_KEY_LINKS_DESTROY`

Removes a single child key from a parent key's link group. A link group is the relationship model that keeps child keys synchronized with a parent: while linked, a child key's translations are derived from the parent's content. When you call this endpoint, the child key leaves the group and becomes independent — its existing translations are updated with the parent's current content and then marked unverified, signalling that reviewers should confirm the content is still appropriate for the child's context. Use this endpoint when you need to detach one specific child key while keeping other children linked. To detach multiple children at once, use the batch unlink endpoint. This operation is only available on main projects. It returns 422 when the child key is not currently linked to the specified parent key, or when a translation update fails during the unlink process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `child_key_id` | string | Yes | Provider child_key_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List child keys of a parent key

**Slug:** `PHRASE_KEY_LINKS_INDEX`

Returns the key link record for a parent key, including all child keys associated with it. Key linking lets translation keys share translations — a child key inherits content from its designated parent. Use this endpoint to inspect which keys are linked under a given parent before unlinking them or auditing translation consistency across related keys. The key identified by `id` must be designated as a parent key (it must have at least one child key linked to it). Listing the links of a key that is not a parent returns 400.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete collection of keys

**Slug:** `PHRASE_KEYS_DELETE_COLLECTION`

Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `branch` | string | No | Provider branch value. |
| `locale_id` | string | No | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Exclude a locale on a collection of keys

**Slug:** `PHRASE_KEYS_EXCLUDE`

Exclude a locale on keys matching query. Same constraints as list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single key

**Slug:** `PHRASE_KEY_SHOW`

Get details on a single key for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Include a locale on a collection of keys

**Slug:** `PHRASE_KEYS_INCLUDE`

Include a locale on keys matching query. Same constraints as list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List keys

**Slug:** `PHRASE_KEYS_LIST`

List all keys for the given project. Alternatively you can POST requests to /search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `sort` | string | No | Provider sort value. |
| `order` | string | No | Provider order value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `locale_id` | string | No | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `include_linked_keys` | boolean | No | Provider include_linked_keys value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add tags to collection of keys

**Slug:** `PHRASE_KEYS_TAG`

Tags all keys matching query. Same constraints as list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove tags from collection of keys

**Slug:** `PHRASE_KEYS_UNTAG`

Removes specified tags from keys matching query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List supported languages

**Slug:** `PHRASE_LANGUAGES_LIST`

Returns all languages/locale codes that Phrase Strings recognizes, mapped to their human-readable display name. This endpoint does not require authentication.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounts

**Slug:** `PHRASE_LIST_ACCOUNTS`

List Phrase Strings accounts available to the connected user and return account IDs for project creation and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum accounts to return in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locales

**Slug:** `PHRASE_LIST_LOCALES`

List or filter locales in a Phrase Strings project and return locale IDs used by translation actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Locale-name prefix filter using Phrase syntax, for example name:en. |
| `branch` | string | No | Project branch to read; omit for the default branch. |
| `sort_by` | string ("name_asc" | "name_desc" | "default_asc" | "default_desc") | No | Field and direction used to sort locales. |
| `page_size` | integer | No | Maximum locales to return in this page (1-100). |
| `project_id` | string | Yes | ID of the project whose locales to list. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `PHRASE_LIST_PROJECTS`

List or search Phrase Strings projects available to the connected user, optionally within one account or limited to favorites.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Project-name search using Phrase syntax, for example name:android; values without name: are ignored. |
| `sort_by` | string ("name_asc" | "name_desc" | "updated_at_asc" | "updated_at_desc" | "space_asc" | "space_desc") | No | Field and direction used to sort projects. |
| `page_size` | integer | No | Maximum projects to return in this page (1-100). |
| `account_id` | string | No | Return only projects in this account ID. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `favorites_only` | boolean | No | When true, return only projects starred by the current user. This is translated to Phrase's favorites filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download a locale

**Slug:** `PHRASE_LOCALE_DOWNLOAD`

Download a locale in a specific file format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `tag` | string | No | Provider tag value. |
| `tags` | string | No | Provider tags value. |
| `branch` | string | No | Provider branch value. |
| `encoding` | string | No | Provider encoding value. |
| `locale_ids` | array | No | Provider locale_ids value. |
| `project_id` | string | Yes | Provider project_id value. |
| `file_format` | string | No | Provider file_format value. |
| `convert_emoji` | boolean | No | Provider convert_emoji value. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `updated_since` | string | No | Provider updated_since value. |
| `format_options` | object | No | Additional formatting and render options. See the format guide for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar` |
| `filter_by_prefix` | boolean | No | Provider filter_by_prefix value. |
| `source_locale_id` | string | No | Provider source_locale_id value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |
| `fallback_locale_id` | string | No | Provider fallback_locale_id value. |
| `use_locale_fallback` | boolean | No | Provider use_locale_fallback value. |
| `keep_notranslate_tags` | boolean | No | Provider keep_notranslate_tags value. |
| `translation_key_prefix` | string | No | Provider translation_key_prefix value. |
| `custom_metadata_filters` | object | No | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. |
| `include_translated_keys` | boolean | No | Provider include_translated_keys value. |
| `exclude_empty_zero_forms` | boolean | No | Provider exclude_empty_zero_forms value. |
| `use_last_reviewed_version` | boolean | No | Provider use_last_reviewed_version value. |
| `include_empty_translations` | boolean | No | Provider include_empty_translations value. |
| `skip_unverified_translations` | boolean | No | Provider skip_unverified_translations value. |
| `include_unverified_translations` | boolean | No | Provider include_unverified_translations value. |
| `fallback_for_unverified_translations` | boolean | No | Provider fallback_for_unverified_translations value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initiate async download of a locale

**Slug:** `PHRASE_LOCALE_DOWNLOAD_CREATE`

Prepare a locale for download in a specific file format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `locale_id` | string | Yes | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Show status of an async locale download

**Slug:** `PHRASE_LOCALE_DOWNLOAD_SHOW`

Show status of already started async locale download. If the download is finished, the download link will be returned.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `locale_id` | string | Yes | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single locale

**Slug:** `PHRASE_LOCALE_SHOW`

Get details on a single locale for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a locale

**Slug:** `PHRASE_LOCALE_UPDATE`

Update an existing locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a locale provider mapping

**Slug:** `PHRASE_MACHINE_TRANSLATION_LOCALE_PROVIDER_MAPPINGS_CREATE`

Creates a locale-pair-specific machine translation provider override for the account. When a mapping exists for a given source/target locale pair, that provider is used instead of the account default. Only one mapping may exist per source/target locale pair; attempting to create a duplicate returns a validation error. The source and target locale codes must differ.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a locale provider mapping

**Slug:** `PHRASE_MACHINE_TRANSLATION_LOCALE_PROVIDER_MAPPINGS_DESTROY`

Removes the machine translation provider override for the specified source and target locale pair. The mapping is identified by locale codes supplied as query parameters rather than a path ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `source_locale_code` | string | Yes | Provider source_locale_code value. |
| `target_locale_code` | string | Yes | Provider target_locale_code value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get machine translation settings

**Slug:** `PHRASE_MACHINE_TRANSLATION_SETTINGS_SHOW`

Returns the machine translation configuration for the account, including the default translation service, current machine translation unit usage, and any locale-pair-specific provider mappings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update machine translation settings

**Slug:** `PHRASE_MACHINE_TRANSLATION_SETTINGS_UPDATE`

Sets the default machine translation service for the account. Requires write access to the account's machine translation settings. Passing an empty or absent value for `default_service` resets the account to its plan default (Microsoft Translate).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove a user from the account

**Slug:** `PHRASE_MEMBER_DELETE`

Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List project members

**Slug:** `PHRASE_MEMBERS_BY_PROJECT`

Get all members active in the project. Access token scope must include `read`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `job_id` | string | No | Provider job_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get single member

**Slug:** `PHRASE_MEMBER_SHOW`

Get details on a single user in the account. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List members

**Slug:** `PHRASE_MEMBERS_LIST`

Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a member

**Slug:** `PHRASE_MEMBER_UPDATE`

Update user permissions in the account. Developers and translators need `project_ids` and `locale_ids` assigned to access them. To grant account-wide language access instead of access scoped to specific projects, use `default_locale_codes`. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a member's project settings

**Slug:** `PHRASE_MEMBER_UPDATE_SETTINGS`

Update user settings in the project. Access token scope must include `team.manage`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List notification groups

**Slug:** `PHRASE_NOTIFICATION_GROUPS_LIST`

List all notification groups from the current user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark all notification groups as read

**Slug:** `PHRASE_NOTIFICATION_GROUPS_MARK_ALL_AS_READ`

Mark all notification groups of the current user as read

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a notification group as read

**Slug:** `PHRASE_NOTIFICATION_GROUPS_MARK_AS_READ`

Mark a notifications group of the current user as read

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List notifications

**Slug:** `PHRASE_NOTIFICATIONS_LIST`

List all notifications from the current user

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `unseen` | boolean | No | Provider unseen value. |
| `per_page` | integer | No | Provider per_page value. |
| `last_days` | integer | No | Provider last_days value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark all notifications as read

**Slug:** `PHRASE_NOTIFICATIONS_MARK_ALL_AS_READ`

Mark all notifications of the current user as read

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single notification

**Slug:** `PHRASE_NOTIFICATIONS_SHOW`

Get details on a single notification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Confirm an order

**Slug:** `PHRASE_ORDER_CONFIRM`

Confirm an existing order and send it to the provider for translation. Same constraints as for create.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new order

**Slug:** `PHRASE_ORDER_CREATE`

Create a new order. Access token scope must include `orders.create`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel an order

**Slug:** `PHRASE_ORDER_DELETE`

Cancel an existing order. Must not yet be confirmed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single order

**Slug:** `PHRASE_ORDER_SHOW`

Get details on a single order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List orders

**Slug:** `PHRASE_ORDERS_LIST`

List all orders for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `translation_id` | string | No | Provider translation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an organization job template

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_CREATE`

Create a new organization job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an organization job template

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_DELETE`

Delete an existing organization job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an organization job template locale

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_LOCALE_DELETE`

Delete an existing organization job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an organization job template locale

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_LOCALES_CREATE`

Create a new organization job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single organization job template locale

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_LOCALE_SHOW`

Get a single job template locale for a given organization job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization job template locales

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_LOCALES_LIST`

List all job template locales for a given organization job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `job_template_id` | string | Yes | Provider job_template_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an organization job template locale

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_LOCALE_UPDATE`

Update an existing organization job template locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `job_template_id` | string | Yes | Provider job_template_id value. |
| `job_template_locale_id` | string | Yes | Provider job_template_locale_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List organization job templates

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATES_LIST`

List all job templates for the given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single organization job template

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATES_SHOW`

Get details on a single organization job template for a given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an organization job template

**Slug:** `PHRASE_ORGANIZATION_JOB_TEMPLATE_UPDATE`

Update an existing organization job template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a pre-translation job

**Slug:** `PHRASE_PRE_TRANSLATION_CREATE`

Triggers a pre-translation job for a resource within a project, addressed by `translatable_type` (`locale`, `job`, `translation_key`, or `upload`) and `translatable_id` (its ID). Enqueues machine translation using the project's configured MT engine.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single pre-translation job

**Slug:** `PHRASE_PRE_TRANSLATION_SHOW`

Returns a single pre-translation job identified by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List pre-translation jobs

**Slug:** `PHRASE_PRE_TRANSLATIONS_LIST`

Returns all pre-translation jobs scoped to a project, ordered by creation date descending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single project

**Slug:** `PHRASE_PROJECT_SHOW`

Get details on a single project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a project

**Slug:** `PHRASE_PROJECT_UPDATE`

Update an existing project, including its review workflow, pre-translation/autotranslate rules, and machine-translation configuration (see workflow, machine_translation_enabled, and the autotranslate_* fields below).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Translation Quality

**Slug:** `PHRASE_QUALITY_PERFORMANCE_SCORE_LIST`

Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a reaction

**Slug:** `PHRASE_REACTION_CREATE`

Create a new reaction for a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emoji` | string | No | Provider emoji value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a reaction

**Slug:** `PHRASE_REACTION_DELETE`

Delete an existing reaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single reaction

**Slug:** `PHRASE_REACTION_SHOW`

Get details on a single reaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List reactions

**Slug:** `PHRASE_REACTIONS_LIST`

List all reactions for a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a release

**Slug:** `PHRASE_RELEASE_CREATE`

Create a new release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a release

**Slug:** `PHRASE_RELEASE_DELETE`

Delete an existing release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish a release

**Slug:** `PHRASE_RELEASE_PUBLISH`

Publish a release for production.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single release

**Slug:** `PHRASE_RELEASE_SHOW`

Get details on a single release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List releases

**Slug:** `PHRASE_RELEASES_LIST`

List all releases for the given distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a release trigger

**Slug:** `PHRASE_RELEASE_TRIGGERS_CREATE`

Create a new recurring release. New releases will be published automatically, based on the cron schedule provided. Currently, only one release trigger can exist per distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a single release trigger

**Slug:** `PHRASE_RELEASE_TRIGGERS_DESTROY`

Delete a single release trigger.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List release triggers

**Slug:** `PHRASE_RELEASE_TRIGGERS_LIST`

List all release triggers for the given distribution. Note: Currently only one release trigger can exist per distribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single release trigger

**Slug:** `PHRASE_RELEASE_TRIGGERS_SHOW`

Get details of a single release trigger.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a release trigger

**Slug:** `PHRASE_RELEASE_TRIGGERS_UPDATE`

Update a recurring release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a release

**Slug:** `PHRASE_RELEASE_UPDATE`

Update an existing release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |
| `distribution_id` | string | Yes | Provider distribution_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List replies

**Slug:** `PHRASE_REPLIES_LIST`

List all replies for a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `order` | string | No | Provider order value. |
| `query` | string | No | Provider query value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `filters` | array | No | Provider filters value. |
| `per_page` | integer | No | Provider per_page value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a reply

**Slug:** `PHRASE_REPLY_CREATE`

Create a new reply for a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a reply

**Slug:** `PHRASE_REPLY_DELETE`

Delete an existing reply.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a reply as read

**Slug:** `PHRASE_REPLY_MARK_AS_READ`

Mark a reply as read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a reply as unread

**Slug:** `PHRASE_REPLY_MARK_AS_UNREAD`

Mark a reply as unread.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single reply

**Slug:** `PHRASE_REPLY_SHOW`

Get details on a single reply.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `comment_id` | string | Yes | Provider comment_id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locale Reports (word count, character count, translation statistics)

**Slug:** `PHRASE_REPORT_LOCALES_LIST`

List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Provider tag value. |
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `locale_codes` | string | No | Provider locale_codes value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Report

**Slug:** `PHRASE_REPORT_SHOW`

Get report of a single project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Activate a Repo Sync

**Slug:** `PHRASE_REPO_SYNC_ACTIVATE`

Activate a deactivated Repo Sync. Active syncs can be used to import and export translations, and imports to Phrase are automatically triggered by pushes to the repository, if configured.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Repo Sync

**Slug:** `PHRASE_REPO_SYNC_CREATE`

Create a new Repo Sync.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deactivate a Repo Sync

**Slug:** `PHRASE_REPO_SYNC_DEACTIVATE`

Deactivate an active Repo Sync. Import and export can't be performed on deactivated syncs and the pushes to the repository won't trigger the import to Phrase.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Repository Syncs History

**Slug:** `PHRASE_REPO_SYNC_EVENT_LIST`

Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single Repo Sync Event

**Slug:** `PHRASE_REPO_SYNC_EVENT_SHOW`

Shows a single Repo Sync event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `repo_sync_id` | string | Yes | Provider repo_sync_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export to code repository

**Slug:** `PHRASE_REPO_SYNC_EXPORT`

Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. *Export is done asynchronously and may take several seconds depending on the project size.*

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | No | Optional JSON request body. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import from code repository

**Slug:** `PHRASE_REPO_SYNC_IMPORT`

Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. _Import is done asynchronously and may take several seconds depending on the project size._

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | No | Optional JSON request body. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Repo Syncs

**Slug:** `PHRASE_REPO_SYNC_LIST`

Lists all Repo Syncs from an account

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single Repo Sync

**Slug:** `PHRASE_REPO_SYNC_SHOW`

Shows a single Repo Sync setting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a repo sync

**Slug:** `PHRASE_REPO_SYNC_UPDATE`

Update settings for an existing Repo Sync. Sending `owner_id`, `export_triggers`, or `export_schedule` requires the caller to have `manage_github_sync?` permission on the project (returns `403` otherwise). Sending `export_triggers` or `export_schedule` when the automatic export feature is not enabled for the account returns `422`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a screenshot

**Slug:** `PHRASE_SCREENSHOT_CREATE`

Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI. This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body. The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename. |
| `branch` | string | No | specify the branch to use |
| `filename` | object | Yes | Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422. |
| `project_id` | string | Yes | Provider project_id value. |
| `description` | string | No | Optional free-text description of the screenshot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a screenshot

**Slug:** `PHRASE_SCREENSHOT_DELETE`

Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-region marker linked to it are destroyed together and cannot be recovered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a screenshot marker

**Slug:** `PHRASE_SCREENSHOT_MARKER_CREATE`

Create a new screenshot marker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |
| `screenshot_id` | string | Yes | Provider screenshot_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a screenshot marker

**Slug:** `PHRASE_SCREENSHOT_MARKER_DELETE`

Delete an existing screenshot marker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `screenshot_id` | string | Yes | Provider screenshot_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single screenshot marker

**Slug:** `PHRASE_SCREENSHOT_MARKER_SHOW`

Get details on a single screenshot marker for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `screenshot_id` | string | Yes | Provider screenshot_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List screenshot markers

**Slug:** `PHRASE_SCREENSHOT_MARKERS_LIST`

List all screenshot markers for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a screenshot marker

**Slug:** `PHRASE_SCREENSHOT_MARKER_UPDATE`

Update an existing screenshot marker.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |
| `screenshot_id` | string | Yes | Provider screenshot_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single screenshot

**Slug:** `PHRASE_SCREENSHOT_SHOW`

Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects. The Attachable Screenshots feature must be enabled on the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List screenshots

**Slug:** `PHRASE_SCREENSHOTS_LIST`

List all screenshots for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | No | Provider key_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a screenshot

**Slug:** `PHRASE_SCREENSHOT_UPDATE`

Update an existing screenshot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search across projects

**Slug:** `PHRASE_SEARCH_IN_ACCOUNT`

Search for keys and translations in all account projects *Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.*

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Keys

**Slug:** `PHRASE_SEARCH_KEYS`

Search translation keys in a Phrase Strings project by text or documented qualifiers such as name:, ids:, tags:, or translated:.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("name" | "created_at" | "updated_at") | No | Field used to sort matching keys. |
| `order` | string ("asc" | "desc") | No | Sort direction. |
| `query` | string | No | Broad key-name search (wildcards supported), optionally using: ids:key_id,...; name:key_name,... for exact names (escape spaces, commas, and colons with double backslashes); tags:tag_name,...; uploads:upload_id,...; job:true or job:false; translated:true or translated:false (requires locale_id); updated_at:>=2013-02-21T00:00:00Z or updated_at:<=2013-02-21T00:00:00Z; and unmentioned_in_upload:upload_id,..., which matches keys unmentioned in all listed uploads. A tags filter searches at most 65,536 tagged keys. Omit to browse keys. |
| `branch` | string | No | Project branch to search; omit for the default branch. |
| `locale_id` | string | No | Locale ID used with translated:true or translated:false filters. |
| `page_size` | integer | No | Maximum keys to return in this page (1-100). |
| `project_id` | string | Yes | ID of the Phrase Strings project whose keys to search. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `include_linked_keys` | boolean | No | Set true to include linked_key details. Omit or set false to leave linked_key out of each result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Translations

**Slug:** `PHRASE_SEARCH_TRANSLATIONS`

Search translations in a Phrase Strings project and return each match with its key and locale context. Results are capped at 10,000 and may lag recent updates in large projects. To download every translation for one locale, use Phrase's locale-download endpoint instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("key_name" | "created_at" | "updated_at") | No | Field used to sort matching translations. |
| `order` | string ("asc" | "desc") | No | Sort direction. |
| `query` | string | No | Translation content query, including wildcards. Supported qualifiers: id: for comma-separated translation IDs; key.id: for key IDs; key.name: for key names; locale.id: for locale IDs; locale.name: for locale names; tags: for tags; unverified:true&#124;false; excluded:true&#124;false; updated_at:>= or <= followed by an ISO 8601 timestamp; and reviewed_after: followed by an ISO 8601 timestamp. Search is capped at 10,000 results and, depending on project size, may not include recently updated data. |
| `branch` | string | No | Project branch to search; omit for the default branch. |
| `page_size` | integer | No | Maximum translations to return in this page (1-100). |
| `project_id` | string | Yes | ID of the Phrase Strings project whose translations to search. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Space

**Slug:** `PHRASE_SPACE_CREATE`

Create a new Space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Space

**Slug:** `PHRASE_SPACE_DELETE`

Delete the specified Space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Space

**Slug:** `PHRASE_SPACE_SHOW`

Show the specified Space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Spaces

**Slug:** `PHRASE_SPACES_LIST`

List all Spaces for the given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Project to Space

**Slug:** `PHRASE_SPACES_PROJECTS_CREATE`

Adds an existing project to the space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `space_id` | string | Yes | Provider space_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Project from Space

**Slug:** `PHRASE_SPACES_PROJECTS_DELETE`

Removes a specified project from the specified space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `space_id` | string | Yes | Provider space_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects in Space

**Slug:** `PHRASE_SPACES_PROJECTS_LIST`

List all projects for the specified Space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `space_id` | string | Yes | Provider space_id value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Space

**Slug:** `PHRASE_SPACE_UPDATE`

Update the specified Space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a style guide

**Slug:** `PHRASE_STYLEGUIDE_CREATE`

Create a new style guide.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a style guide

**Slug:** `PHRASE_STYLEGUIDE_DELETE`

Delete an existing style guide.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single style guide

**Slug:** `PHRASE_STYLEGUIDE_SHOW`

Get details on a single style guide.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List style guides

**Slug:** `PHRASE_STYLEGUIDES_LIST`

List all styleguides for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a style guide

**Slug:** `PHRASE_STYLEGUIDE_UPDATE`

Update an existing style guide.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a tag

**Slug:** `PHRASE_TAG_CREATE`

Create a new tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a tag

**Slug:** `PHRASE_TAG_DELETE`

Delete an existing tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single tag

**Slug:** `PHRASE_TAG_SHOW`

Get details and progress information on a single tag for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `omit_statistics` | boolean | No | Provider omit_statistics value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List tags

**Slug:** `PHRASE_TAGS_LIST`

List all tags for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `only_system_tags` | boolean | No | Provider only_system_tags value. |
| `exclude_system_tags` | boolean | No | Provider exclude_system_tags value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Team

**Slug:** `PHRASE_TEAM_CREATE`

Create a new Team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Team

**Slug:** `PHRASE_TEAM_DELETE`

Delete the specified Team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team

**Slug:** `PHRASE_TEAM_SHOW`

Show the specified Team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `PHRASE_TEAMS_LIST`

List all Teams for the given account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `account_id` | string | Yes | Provider account_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Project to Team

**Slug:** `PHRASE_TEAMS_PROJECTS_CREATE`

Adds an existing project to the team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Project from Team

**Slug:** `PHRASE_TEAMS_PROJECTS_DELETE`

Removes a specified project from the specified team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Space

**Slug:** `PHRASE_TEAMS_SPACES_CREATE`

Adds an existing space to the team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Space

**Slug:** `PHRASE_TEAMS_SPACES_DELETE`

Removes a specified space from the specified team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add User

**Slug:** `PHRASE_TEAMS_USERS_CREATE`

Adds an existing user to the team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove User

**Slug:** `PHRASE_TEAMS_USERS_DELETE`

Removes a specified user from the specified team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `team_id` | string | Yes | Provider team_id value. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Team

**Slug:** `PHRASE_TEAM_UPDATE`

Update the specified Team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `account_id` | string | Yes | Provider account_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Exclude a translation from export

**Slug:** `PHRASE_TRANSLATION_EXCLUDE`

Set exclude from export flag on an existing translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Include a translation

**Slug:** `PHRASE_TRANSLATION_INCLUDE`

Remove exclude from export flag from an existing translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review a translation

**Slug:** `PHRASE_TRANSLATION_REVIEW`

Mark an existing translation as reviewed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List translations by key

**Slug:** `PHRASE_TRANSLATIONS_BY_KEY`

List translations for a specific key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `sort` | string | No | Provider sort value. |
| `order` | string | No | Provider order value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | Yes | Provider key_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List translations by locale

**Slug:** `PHRASE_TRANSLATIONS_BY_LOCALE`

List translations for a specific locale. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `sort` | string | No | Provider sort value. |
| `order` | string | No | Provider order value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `locale_id` | string | Yes | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Exclude translations by query

**Slug:** `PHRASE_TRANSLATIONS_EXCLUDE_COLLECTION`

Exclude translations matching query from locale export.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single translation

**Slug:** `PHRASE_TRANSLATION_SHOW`

Get details on a single translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Include translations by query

**Slug:** `PHRASE_TRANSLATIONS_INCLUDE_COLLECTION`

Include translations matching query in locale export.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all translations

**Slug:** `PHRASE_TRANSLATIONS_LIST`

List translations for the given project. If you want to download all translations for one locale we recommend to use the `locales#download` endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Provider q value. |
| `page` | integer | No | Provider page value. |
| `sort` | string | No | Provider sort value. |
| `order` | string | No | Provider order value. |
| `branch` | string | No | Provider branch value. |
| `key_id` | string | No | Provider key_id value. |
| `per_page` | integer | No | Provider per_page value. |
| `locale_id` | string | No | Provider locale_id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `if_none_match` | string | No | Provider If-None-Match value. |
| `if_modified_since` | string | No | Provider If-Modified-Since value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review translations selected by query

**Slug:** `PHRASE_TRANSLATIONS_REVIEW_COLLECTION`

Review translations matching query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unreview translations selected by query

**Slug:** `PHRASE_TRANSLATIONS_UNREVIEW_COLLECTION`

Unreview translations matching query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unverify translations by query

**Slug:** `PHRASE_TRANSLATIONS_UNVERIFY_COLLECTION`

Mark translations matching query as unverified. To unverify the translations of specific keys, filter by key id (and optionally locale) directly, for example `key.id:KEY_ID_1,KEY_ID_2 locale.id:LOCALE_ID`. There is no need to look up translation ids first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify translations by query

**Slug:** `PHRASE_TRANSLATIONS_VERIFY_COLLECTION`

Verify translations matching query.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unreview a translation

**Slug:** `PHRASE_TRANSLATION_UNREVIEW`

Mark a reviewed translation as translated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a translation as unverified

**Slug:** `PHRASE_TRANSLATION_UNVERIFY`

Mark an existing translation as unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify a translation

**Slug:** `PHRASE_TRANSLATION_VERIFY`

Verify an existing translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Key

**Slug:** `PHRASE_UPDATE_KEY`

Update the documented attributes of one Phrase Strings translation key; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New key name; omit to leave unchanged. |
| `tags` | array | No | Replacement tags, sent to Phrase as comma-separated text. |
| `branch` | string | No | Project branch containing the key; omit for the default branch. |
| `key_id` | string | Yes | ID of the key to update. |
| `plural` | boolean | No | Whether the key supports plural forms. |
| `data_type` | string ("string" | "number" | "boolean" | "array" | "markdown") | No | New value type for the key. |
| `project_id` | string | Yes | ID of the project containing the key. |
| `screenshot` | string | No | Deprecated screenshot/image value. Prefer the Phrase Screenshots endpoint. |
| `description` | string | No | New translator context; send null or an empty string to clear it, and omit to leave unchanged. |
| `name_plural` | string | No | New plural key name; send null or an empty string to clear it. |
| `unformatted` | boolean | No | Whether exports should treat the key as unformatted. |
| `original_file` | string | No | Original file attribute; send null or an empty string to clear it. |
| `custom_metadata` | object | No | Metadata properties to create or update; set a property value to null to delete that property. |
| `format_value_type` | string | No | Value type override used when exporting the key. |
| `remove_screenshot` | boolean | No | Deprecated flag indicating whether to delete the legacy screenshot. Prefer the Phrase Screenshots endpoint. |
| `use_ordinal_rules` | boolean | No | Whether the key uses ordinal pluralization rules. |
| `xml_space_preserve` | boolean | No | Whether XML-based exports should preserve whitespace for this key. |
| `excluded_in_locales` | array | No | Replacement locale exclusions; pass an empty array to clear exclusions. |
| `localized_format_key` | string | No | NSStringLocalizedFormatKey attribute; send null or an empty string to clear it. |
| `max_characters_allowed` | integer | No | New maximum translation length. |
| `localized_format_string` | string | No | NSStringLocalizedFormatKey attribute; send null or an empty string to clear it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Translation

**Slug:** `PHRASE_UPDATE_TRANSLATION`

Update the content or reversible workflow state of one Phrase Strings translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `branch` | string | No | Project branch containing the translation; omit for the default branch. |
| `content` | string | No | New translation content; send an empty string or null to clear it, and omit it to leave the content unchanged. |
| `excluded` | boolean | No | Whether to exclude the translation from exports. |
| `reviewed` | boolean | No | Whether to mark the translation as reviewed. |
| `project_id` | string | Yes | ID of the project containing the translation. |
| `unverified` | boolean | No | Whether the translation is unverified; false marks it translated in the basic workflow. |
| `minor_change` | boolean | No | Whether this update should avoid triggering downstream re-verification. |
| `autotranslate` | boolean | No | Whether Phrase should auto-translate the translation. Phrase returns 422 for a non-default locale or a project without Autopilot enabled. |
| `plural_suffix` | string ("zero" | "one" | "two" | "few" | "many" | "other") | No | Plural form for a pluralized key. |
| `translation_id` | string | Yes | ID of the translation to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create upload batch

**Slug:** `PHRASE_UPLOAD_BATCHES_CREATE`

Groups multiple file uploads into a single batch. Optionally, launches the deletion of unmentioned translation keys after all uploads in the batch are completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload a new file

**Slug:** `PHRASE_UPLOAD_CREATE`

Upload a new language file. Creates necessary resources in your project. The upload is processed asynchronously: this endpoint returns `201 Created` once the file has been accepted and enqueued, not once processing has finished. Poll `GET /projects/{project_id}/uploads/{id}` and check the `state` field — `error` means processing failed (for example, an unparseable file or a `file_format` that doesn't match the file's actual content). Note: be aware of upload limits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to be imported |
| `tags` | string | No | List of tags separated by comma to be associated with the new keys contained in the upload. |
| `branch` | string | No | specify the branch to use |
| `locale_id` | string | Yes | Locale of the file's content. Can be the name or id of the locale. Preferred is id. |
| `project_id` | string | Yes | Provider project_id value. |
| `file_format` | string | Yes | File format of the uploaded file, given as a format's `api_name`. See our Formats API Endpoint for the full list of supported formats. Optional. When omitted, Phrase tries to auto-detect the format from the file's content. This is not always possible for JSON files, since several JSON-based formats (e.g. `json`, `simple_json`, `nested_json`) share the same structure. |
| `autotranslate` | boolean | No | If set, translations for the uploaded language will be fetched automatically. |
| `convert_emoji` | boolean | No | This option is obsolete. Providing the option will cause a bad request error. |
| `file_encoding` | string | No | Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1". |
| `mark_reviewed` | boolean | No | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. |
| `format_options` | object | No | Additional options available for specific formats. See our format guide for the complete list. |
| `locale_mapping` | object | No | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. |
| `skip_upload_tags` | boolean | No | Indicates whether the upload should not create upload tags. |
| `source_locale_id` | string | No | Specifies the source locale for multilingual files. Can be the name or id of the locale. Preferred is id. |
| `skip_unverification` | boolean | No | Indicates whether the upload should unverify updated translations. |
| `update_descriptions` | boolean | No | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. |
| `update_translations` | boolean | No | Indicates whether existing translations should be updated with the file content. |
| `tag_only_affected_keys` | boolean | No | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` |
| `translation_key_prefix` | string | No | This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized. |
| `update_custom_metadata` | boolean | No | Determines whether to update custom metadata values when uploading a file. If set to true, existing metadata can be changed or removed. Passing an empty value deletes the corresponding metadata property. |
| `update_translation_keys` | boolean | No | Pass `false` here to prevent new keys from being created and existing keys updated. |
| `skip_automated_job_creation` | boolean | No | When `true`, the automation rules for the project will not fire for this upload, so no jobs are created as a side effect of importing this file. Defaults to `false`. |
| `verify_mentioned_translations` | boolean | No | Indicates whether all translations mentioned in the upload should be verified. |
| `update_translations_on_source_match` | boolean | No | Update target translations only if the source translations of the uploaded multilingual file match the stored translations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single upload

**Slug:** `PHRASE_UPLOAD_SHOW`

View details and summary for a single upload. Use this endpoint to poll for the outcome of an upload created via `POST /projects/{project_id}/uploads` — check the `state` field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List uploads

**Slug:** `PHRASE_UPLOADS_LIST`

List all uploads for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a variable

**Slug:** `PHRASE_VARIABLE_CREATE`

Create a new variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a variable

**Slug:** `PHRASE_VARIABLE_DELETE`

Delete an existing variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single variable

**Slug:** `PHRASE_VARIABLE_SHOW`

Get details on a single variable for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List variables

**Slug:** `PHRASE_VARIABLES_LIST`

List all variables for the current project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a variable

**Slug:** `PHRASE_VARIABLE_UPDATE`

Update an existing variable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `name` | string | Yes | Provider name value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single version

**Slug:** `PHRASE_VERSION_SHOW`

Get details on a single version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `branch` | string | No | Provider branch value. |
| `project_id` | string | Yes | Provider project_id value. |
| `translation_id` | string | Yes | Provider translation_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all versions

**Slug:** `PHRASE_VERSIONS_LIST`

List all changes done to a given translation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `branch` | string | No | Provider branch value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |
| `translation_id` | string | Yes | Provider translation_id value. |
| `only_content_updates` | boolean | No | Provider only_content_updates value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a webhook

**Slug:** `PHRASE_WEBHOOK_CREATE`

Create a webhook with an optional unique signing key used by the receiver to verify webhook signatures. Omitting it uses the Phrase project's default signing key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a webhook

**Slug:** `PHRASE_WEBHOOK_DELETE`

Delete an existing webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhook deliveries

**Slug:** `PHRASE_WEBHOOK_DELIVERIES_LIST`

List all webhook deliveries for the given webhook_id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("success" | "failed") | No | Provider status value. |
| `project_id` | string | Yes | Provider project_id value. |
| `webhook_id` | string | Yes | Provider webhook_id value. |
| `response_status_codes` | string | No | Provider response_status_codes value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Redeliver a single webhook delivery

**Slug:** `PHRASE_WEBHOOK_DELIVERIES_REDELIVER`

Trigger an individual webhook delivery to be redelivered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `webhook_id` | string | Yes | Provider webhook_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single webhook delivery

**Slug:** `PHRASE_WEBHOOK_DELIVERIES_SHOW`

Get all information about a single webhook delivery for the given ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |
| `webhook_id` | string | Yes | Provider webhook_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single webhook

**Slug:** `PHRASE_WEBHOOK_SHOW`

Get details on a single webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhooks

**Slug:** `PHRASE_WEBHOOKS_LIST`

List all webhooks for the given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page value. |
| `per_page` | integer | No | Provider per_page value. |
| `project_id` | string | Yes | Provider project_id value. |
| `next_cursor` | string | No | Continuation cursor returned by a previous generated action call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test a webhook

**Slug:** `PHRASE_WEBHOOK_TEST`

Perform a test request for a webhook. Sends a synthetic `test:event` payload to the webhook's `callback_url` and returns the webhook resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a webhook

**Slug:** `PHRASE_WEBHOOK_UPDATE`

Update an existing webhook, optionally rotating its unique signing key used by the receiver to verify webhook signatures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Provider id value. |
| `body` | object | Yes | JSON request body documented by Phrase. |
| `project_id` | string | Yes | Provider project_id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
