> ## Documentation Index
> Fetch the complete documentation index at: https://docs.textsetu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upsert a translation value (write)

> Set the translation for one key in one language, creating the value if it doesn't exist. If the project requires approval, a write by a non-approver lands as `pending_review`; approvers' writes are auto-approved — see the [approval workflow](/docs/guides/approval-workflow). Pass `?branch=` to stage the change on a branch.

**Constraints:**
- For a Translator-scoped token, the target language must be within the token owner's assigned languages, or the request is rejected with 403.
- For a plural key, pass `pluralForm` (`one`, `other`, …) to target a specific form.



## OpenAPI

````yaml /openapi/textsetu.json put /projects/{projectId}/keys/{keyId}/values/{lang}
openapi: 3.1.0
info:
  title: TextSetu API
  version: 1.2.0
  description: >-
    Public REST API for TextSetu. Authenticate with a Personal Access Token
    (tsu_pat_…) or a project token (tsu_proj_…) via the `Authorization: Bearer
    <token>` header.


    **Authorization is permission-based.** Every token carries an explicit
    allow-list of RBAC permission keys (e.g. `translation_read`), and each
    endpoint declares the permission it requires (`x-permission`). A token's
    effective access is its underlying authority ∩ its allow-list — a PAT is
    further bounded by its owner's role-based permissions, so it can only
    narrow, never exceed, what the owner already has. A project token is bound
    to a single project. There are no coarse read/write/manage scopes.


    **Response envelope.** Every endpoint returns `{ "success": true, "data": …
    }` on success and `{ "success": false, "error": { "code", "message" } }` on
    failure.


    **Rate limit.** 600 requests/minute, keyed by token (or by IP when
    unauthenticated). Exceeding it returns 429 with the standard error envelope.
servers:
  - url: https://api.textsetu.com/api/v1
    description: Production
  - url: /api/v1
    description: This server (self-hosted / same-origin)
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Read project metadata — settings, key separator, and the
      approval/branching flags that shape how the other endpoints behave.
  - name: Languages
    description: >-
      List and manage a project's target languages. Each language is referenced
      by its BCP-47 code; the source language is flagged separately.
  - name: Translations
    description: >-
      Manage a project's translations: create, read, update, and delete
      translation keys — the identifiers your app looks up, carrying metadata
      (description, tags, screenshot) — and set the translated value for a key
      in a given language. Value writes honor the project's approval workflow —
      non-approver writes land as `pending_review`.
  - name: Stats
    description: >-
      Per-language completeness and approval progress for a project — the
      numbers behind the dashboard.
  - name: Import/Export
    description: >-
      Bulk-load source files into a project or export the current translations.
      Supports the same file formats as the web app.
  - name: Branches
    description: >-
      Work on translations in isolation and merge them back. Branch reads/writes
      mirror the main endpoints but stage changes as a diff until merge. See the
      [branching guide](/docs/guides/branches).
  - name: Glossary
    description: >-
      Manage term bases — approved terminology and its translations — and check
      a string against them. See the [glossary guide](/docs/guides/glossary).
  - name: Translation Memory
    description: >-
      Reusable translation stores. Fuzzy-match and concordance-search prior
      translations to reuse them. See the [translation memory
      guide](/docs/guides/translation-memory).
  - name: AI
    description: >-
      Machine-translate a project with the org's configured AI engine (brand
      voice, glossary/TM grounding, and an optional review pass). Runs
      asynchronously — start a run and poll the returned `jobId`.
  - name: Webhooks
    description: >-
      Get notified when a project's translations change, instead of polling.
      Register an HTTPS endpoint, subscribe it to the events you care about, and
      TextSetu POSTs a signed payload whenever one occurs. Payloads follow the
      [Standard Webhooks](https://www.standardwebhooks.com) spec — verify the
      `webhook-signature` header with any compatible library. Delivery is
      at-least-once and unordered, so treat `webhook-id` as an idempotency key.
      Failed deliveries are retried five times over roughly seven hours, and
      every attempt is inspectable and replayable via the delivery log.
  - name: Meta
    description: Service-level and cross-cutting endpoints.
paths:
  /projects/{projectId}/keys/{keyId}/values/{lang}:
    put:
      tags:
        - Translations
      summary: Upsert a translation value (write)
      description: >-
        Set the translation for one key in one language, creating the value if
        it doesn't exist. If the project requires approval, a write by a
        non-approver lands as `pending_review`; approvers' writes are
        auto-approved — see the [approval
        workflow](/docs/guides/approval-workflow). Pass `?branch=` to stage the
        change on a branch.


        **Constraints:**

        - For a Translator-scoped token, the target language must be within the
        token owner's assigned languages, or the request is rejected with 403.

        - For a plural key, pass `pluralForm` (`one`, `other`, …) to target a
        specific form.
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
          description: Project id (UUID) or id-embedded path slug.
        - name: keyId
          in: path
          required: true
          schema:
            type: string
          description: Translation key id (UUID).
        - name: lang
          in: path
          required: true
          schema:
            type: string
          description: Language code, optionally with a file extension (`fr` or `fr.json`).
        - name: branch
          in: query
          schema:
            type: string
          description: >-
            Target an open translation branch instead of main. Required when the
            project's main branch is protected.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  description: The translated string to store.
                  examples:
                    - Bienvenue
                pluralForm:
                  description: >-
                    For plural keys, the CLDR plural form this value targets
                    (`one`, `other`, …).
                  examples:
                    - other
                  type: string
                  enum:
                    - zero
                    - one
                    - two
                    - few
                    - many
                    - other
              required:
                - value
      responses:
        '200':
          description: The upserted value.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      value:
                        type: object
                        properties:
                          languageCode:
                            type: string
                            description: BCP-47 language code this value is written in.
                            examples:
                              - fr
                          value:
                            type: string
                            description: The translated string for this language.
                            examples:
                              - Bienvenue
                          status:
                            type: string
                            description: >-
                              Review state: `approved`, `pending_review`, or
                              `draft`. Branch overrides are always `draft`.
                            examples:
                              - approved
                          pluralForm:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: >-
                              CLDR plural category (`one`, `other`, …) for
                              plural keys on main; `null` for singular keys and
                              all branch values.
                            examples:
                              - null
                          isOutdated:
                            type: boolean
                            description: >-
                              True when the source string changed after this
                              value was last set.
                            examples:
                              - false
                        required:
                          - languageCode
                          - value
                          - status
                          - pluralForm
                          - isOutdated
                        additionalProperties: false
                    required:
                      - value
                    additionalProperties: false
        '403':
          description: >-
            Language out of scope, or direct edits to a protected main branch
            are blocked.
        '404':
          description: Project or key not found.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's
        granted RBAC permissions determine access; see each operation's
        `x-permission`.

````