Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

Body

application/json
upload_ids
string[]
required

Array of upload IDs to include in the batch

Example:
branch
string

specify the branch to use

Example:

"my-feature-branch"

delete_unmentioned_keys
boolean

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.

Example:

true

Response

Created

status
enum<string>

Processing state of the upload batch

Available options:
started,
done
delete_unmentioned_keys
boolean

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

uploads_count
integer

Number of uploads attached to this batch.

created_at
string<date-time>
updated_at
string<date-time>
project
project_short · object
Example:
user
user_preview · object
Example:
uploads
upload · object[]