Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Keys

Include a locale on a collection of keys

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

patch/projects/{project_id}/keys/include

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

qstring

Specify a query to do broad search for keys by name (including wildcards).

The following qualifiers are also supported in the search term:

  • ids:key_id,... for queries on a comma-separated list of ids
  • name:key_name for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes
  • tags:tag_name to filter for keys with certain tags
  • translated:{true|false} for translation status (also requires locale_id to be specified)
  • updated_at:{>=|<=}2013-02-21T00:00:00Z for date range queries
  • unmentioned_in_upload:upload_id,... to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in all uploads

Find more examples here.

target_locale_idstring

Include translations in locale

tagsstring

Tag or comma-separated list of tags to add to the matching collection of keys

Example request

{
  "branch": "my-feature-branch",
  "q": "mykey* translated:true",
  "target_locale_id": "abcd1234abcd1234abcd1234abcd1234",
  "tags": "landing-page,release-1.2"
}

Response

OK

records_affectedinteger

Example response

{
  "records_affected": 2
}