Skip to main content
POST
Create project

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

Project creation request

name
string
required
Maximum string length: 255
sourceLang
string
required
targetLangs
string[]
required
businessUnit
object
client
object
costCenter
object
customFields
object[]

Custom fields for project

dateDue
string<date-time>
domain
object
fileHandover
boolean

When true, enables file handover for the project

lqaProfiles
object[]

Lqa profiles that will be added to workflow steps

note
string
Maximum string length: 4096
propagateTranslationsToLowerWfDuringUpdateSource
boolean

When true, propagates translations to lower workflow steps during source update

purchaseOrder
string
Maximum string length: 255
subDomain
object
workflowSteps
object[]

Response

Created

Base projectDto

userRole
string
required
read-only

Response differs based on user's role

dateCreated
string<date-time>

Date the project was created

domain
object
id
string

Internal numeric identifier, encoded as a string

internalId
integer<int32>

Sequential numeric identifier scoped to the organization (first project in the org is 1)

mtSettingsPerLanguageList
object[]

Machine translation settings per target language

name
string

Project name

owner
object
references
object[]

Reference files attached to the project

sourceLang
string

Source language code

status
enum<string>

Project status; one of NEW, ASSIGNED, COMPLETED, ACCEPTED_BY_VENDOR, DECLINED_BY_VENDOR, COMPLETED_BY_VENDOR, CANCELLED. Null when the organization hides progress and status from non-linguist, non-bot callers.

Available options:
NEW,
ASSIGNED,
COMPLETED,
ACCEPTED_BY_VENDOR,
DECLINED_BY_VENDOR,
COMPLETED_BY_VENDOR,
CANCELLED
subDomain
object
targetLangs
string[]

Target language codes

uid
string

Unique identifier used in API paths