Shipeasy
Flags experimentsApiOperations

Create a translation draft

Stage a new translation draft against a target profile, optionally seeding its keys from a source profile.

Stage a new translation draft against a target profile, optionally seeding its keys from a source profile.

Use case

Open a machine-translation draft for review before publishing it to a locale.

POST
/api/admin/i18n/drafts

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/i18n/drafts" \  -H "Content-Type: application/json" \  -d '{    "name": "fr:prod",    "profile_id": "3f1a6c2e-1b2c-4d5e-8f90-0a1b2c3d4e5f"  }'
{
  "id": "draft_01j7",
  "name": "fr:prod",
  "profileId": "3f1a6c2e-1b2c-4d5e-8f90-0a1b2c3d4e5f",
  "status": "open"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page