Style Guides

Edit Style Guide

Required scopes: style-guide (Read and Write).

Updates a style guide. A remove on /managerIds/{managerId} with your own ID, sent as the only operation in the request, stops you managing the style guide instead. If you created the style guide, the account owner becomes its author. To change another manager's access to the style guide, use Edit Manager.

Note: If you still manage a project that uses the style guide, you can keep reading it there

patch/style-guides/{styleGuideId}

Request

Path parameters

styleGuideIdinteger required

Style Guide Identifier

Request body

op'replace' | 'test' | 'remove' required

Patch operation to perform

path'/name' | '/aiInstructions' | '/languageIds' | '/projectIds' | '/isShared' | '/storageId' | '/managerIds/{managerId}' json-pointer required

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

Response

Style Guide was successfully updated

Example response

{
  "data": {
    "id": 2,
    "name": "Be My Eyes iOS's Style Guide",
    "aiInstructions": "Rules to be used by AI models",
    "userId": 2,
    "languageIds": [
      "uk",
      "fr",
      "de"
    ],
    "projectIds": [
      6
    ],
    "webUrl": "https://crowdin.com/profile/{userName}/style-guides?id=1",
    "downloadLink": "https://storage.crowdin.com/style-guide/123/456/file.pdf",
    "createdAt": "2019-09-16T13:42:04+00:00",
    "updatedAt": "2019-09-16T13:42:04+00:00",
    "managerIds": [
      13240049
    ]
  }
}

Changes

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