Skip to content
localisyncDocs
Open panel

Create a frozen Translate or Review task

Requires current workspace membership. Manager-only operations include permission and project-link management. Text approval requires a separate language review grant; resource editor access never grants translation permissions. Expected versions and branch scope are checked before mutation. Source and context text are not telemetry.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/tasks

Operation: createWorkflowTask · Download OpenAPI

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
"type": "apiKey",
"in": "cookie",
"name": "localisync_session"
}
Name Location Required Description
workspaceId path Yes See constraints below.
projectId path Yes See constraints below.
branchId path Yes See constraints below.
Origin header Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
Idempotency-Key header Yes See constraints below.
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uri"
}
{
"type": "string"
}
{
"type": "string",
"format": "uuid"
}

Required: Yes.

Schema reference: TaskInput.

Field Type Required Constraints / description
title string Yes minLength: 1; maxLength: 200
kind translate, review Yes —
keys Array of string Yes minItems: 1; maxItems: 10000
assignments Array of object Yes minItems: 1; maxItems: 1000
dueAt See schema Yes —
timeZone string Yes minLength: 1; maxLength: 100; pattern: "^[A-Za-z][A-Za-z0-9._+-]*(?:\\/[A-Za-z0-9._+-]+)*$"
{
"$ref": "#/components/schemas/TaskInput"
}

Result returned.

Content type: application/json Schema reference: TaskDetail.

Field Type Required Constraints / description
id string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
title string Yes —
kind translate, review Yes —
creatorId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
version integer Yes maximum: 2147483646
dueAt See schema Yes —
timeZone string Yes —
createdAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
canManage boolean Yes —
total integer Yes minimum: -9007199254740991; maximum: 9007199254740991
completed integer Yes minimum: -9007199254740991; maximum: 9007199254740991
blocked integer Yes minimum: -9007199254740991; maximum: 9007199254740991
status open, complete, blocked Yes —
keys Array of string Yes maxItems: 10000
assignments Array of object Yes minItems: 1; maxItems: 1000
assigneeNames object Yes —
{
"$ref": "#/components/schemas/TaskDetail"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.