Source Strings

Edit String

Required scopes: project.source.string (Read and Write).

patch/projects/{projectId}/strings/{stringId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

stringIdinteger required

String Identifier. Get via List Strings

Query parameters

updateOption'keep_translations_and_approvals' | 'keep_translations' | 'clear_translations_and_approvals'

Defines whether to keep existing translations and approvals for updated string.

NOTE: Applied only when text or identifier is changed.

Request body

op'replace' | 'test' required

Patch operation to perform

path'/identifier' | '/text' | '/context' | '/isHidden' | '/maxLength' | '/labelIds' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Example request

[
  {
    "op": "replace",
    "path": "/isHidden",
    "value": true
  }
]

Response

String was successfully updated

Example response

{
  "data": {
    "id": 2814,
    "projectId": 2,
    "branchId": 12,
    "identifier": "name",
    "text": "Not all videos are shown to users. See more",
    "type": "text",
    "context": "shown on main page",
    "maxLength": 35,
    "isDuplicate": true,
    "masterStringId": 1,
    "labelIds": [
      3
    ],
    "webUrl": "https://example.crowdin.com/editor/1/all/en-pl?filter=basic&value=0&view=comfortable#2",
    "createdAt": "2019-09-20T12:43:57+00:00",
    "updatedAt": "2019-09-20T13:24:01+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.