Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Keys

Delete collection of keys

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.

delete/projects/{project_id}/keys

Path parameters

project_idstring required

Project ID

Query parameters

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

Caution: Query parameters with empty values will be treated as though they are not included in the request and will be ignored.

Find more examples here.

locale_idstring

Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

records_affectedinteger

Example response

{
  "records_affected": 2
}