Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Upload Batches

Create upload batch

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

post/projects/{project_id}/upload_batches

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

delete_unmentioned_keysboolean

If set to true, after all uploads in the batch are completed, translation keys that were not mentioned in any of the uploaded files will be deleted.

upload_idsstring[] required

Array of upload IDs to include in the batch

Example request

{
  "branch": "my-feature-branch",
  "delete_unmentioned_keys": true,
  "upload_ids": [
    "abcd1234cdef1234abcd1234cdef1234",
    "bcde2345defg2345bcde2345defg2345"
  ]
}

Response

Created

status'started' | 'done'

Processing state of the upload batch

delete_unmentioned_keysboolean

Indicates whether unmentioned keys will be deleted after processing all uploads in the batch

uploads_countinteger

Number of uploads attached to this batch.

created_atstring date-time
updated_atstring date-time

Example response

{
  "project": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "My Android Project",
    "main_format": "xml",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  },
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "johndoe",
    "name": "John Doe",
    "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
  },
  "uploads": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "filename": "example.json",
      "format": "json",
      "state": "success",
      "tag": "tag",
      "summary": {
        "locales_created": 2,
        "translation_keys_created": 162,
        "translation_keys_updated": 10,
        "translation_keys_unmentioned": 0,
        "translations_created": 291,
        "translations_updated": 3,
        "tags_created": 2,
        "translation_keys_ignored": 0
      },
      "user": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "username": "johndoe",
        "name": "John Doe",
        "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
      },
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  ]
}