Skip to content
localisyncDocs
Open panel

Validate and save a versioned proposal

Current workspace membership is required. Owner/Admin manage connections and all jobs; Editors can select safe connection metadata and manage their own jobs. Viewers cannot use assistance. Explicit branch scope, Missing-only targets and active languages are enforced. Preview/suggestions expire after 24 hours. Source text is sent only after usage approval; uncertain paid calls require explicit retry approval. UTC counters cover only Localisync use. All responses are no-store.

PATCH /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/translation-assistance/jobs/{id}/suggestions/{itemId}

Operation: editTranslationSuggestion · Download OpenAPI

Access

Section titled “Access”

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Section titled “Parameters”
Name Location Required Description
workspaceId path Yes See constraints below.
projectId path Yes See constraints below.
branchId path Yes See constraints below.
id path Yes See constraints below.
itemId path Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
Origin header Yes See constraints below.

workspaceId

Section titled “workspaceId”
{
  "type": "string",
  "format": "uuid"
}

projectId

Section titled “projectId”
{
  "type": "string",
  "format": "uuid"
}

branchId

Section titled “branchId”
{
  "type": "string",
  "format": "uuid"
}

id

Section titled “id”
{
  "type": "string",
  "format": "uuid"
}

itemId

Section titled “itemId”
{
  "type": "string",
  "format": "uuid"
}

X-CSRF-Token

Section titled “X-CSRF-Token”
{
  "type": "string"
}

Origin

Section titled “Origin”
{
  "type": "string"
}

Request body

Section titled “Request body”

Required: Yes.

application/json

Section titled “application/json”

Schema reference: SuggestionUpdate.

Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991
value string Yes maxLength: 16384 
{
  "$ref": "#/components/schemas/SuggestionUpdate"
}

Responses

Section titled “Responses”

200

Section titled “200”

Operation confirmed. Generation is asynchronous; proposals do not change translations until explicit Apply.

Content type: application/json Schema reference: Suggestion.

Field Type Required Constraints / description
context Array of object Yes maxItems: 161
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)$"
jobId 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)$"
keyId See schema Yes —
definition object Yes —
keyVersion number Yes —
sourceVersion number Yes —
targetVersion number Yes —
source string Yes —
sourceLocale string Yes —
locale string Yes —
suggestion string or null Yes —
state pending, sending, ready, invalid, unknown, applied Yes —
issue string or null Yes —
version integer Yes maximum: 9007199254740991
current See schema No — 
{
  "$ref": "#/components/schemas/Suggestion"
}

400

Section titled “400”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

401

Section titled “401”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

403

Section titled “403”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

404

Section titled “404”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

409

Section titled “409”

Stale scope/version, archived content or idempotency conflict. No partial Apply.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

413

Section titled “413”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

429

Section titled “429”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

500

Section titled “500”

Request rejected. Safe reference is provided; provider bodies and credentials are omitted.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}

503

Section titled “503”

Dependency unavailable; usable translations and existing delivery are unaffected.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
details Array of object No —
requestId 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)$" 
{
  "$ref": "#/components/schemas/Error"
}
Section titled “Related guidance”

Request errors and safe retries · Troubleshooting

Localisync byWetus

Cookie preferences

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

Cookie policyWebsite privacy