Skip to main content
PATCH
/
api
/
v1
/
rules
/
{id}
Update a Rule
curl --request PATCH \
  --url https://eu.phrase.com/styleguide/api/v1/rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule": "Avoid passive voice in all user-facing content.",
  "allContentGroups": true,
  "contentGroupIds": [
    "<string>"
  ],
  "allLanguages": true,
  "languages": [
    "<string>"
  ],
  "active": true,
  "aiCheckEnabled": true,
  "forceUnlink": false
}
'
import requests

url = "https://eu.phrase.com/styleguide/api/v1/rules/{id}"

payload = {
"rule": "Avoid passive voice in all user-facing content.",
"allContentGroups": True,
"contentGroupIds": ["<string>"],
"allLanguages": True,
"languages": ["<string>"],
"active": True,
"aiCheckEnabled": True,
"forceUnlink": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rule: 'Avoid passive voice in all user-facing content.',
allContentGroups: true,
contentGroupIds: ['<string>'],
allLanguages: true,
languages: ['<string>'],
active: true,
aiCheckEnabled: true,
forceUnlink: false
})
};

fetch('https://eu.phrase.com/styleguide/api/v1/rules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.phrase.com/styleguide/api/v1/rules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'rule' => 'Avoid passive voice in all user-facing content.',
'allContentGroups' => true,
'contentGroupIds' => [
'<string>'
],
'allLanguages' => true,
'languages' => [
'<string>'
],
'active' => true,
'aiCheckEnabled' => true,
'forceUnlink' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://eu.phrase.com/styleguide/api/v1/rules/{id}"

payload := strings.NewReader("{\n \"rule\": \"Avoid passive voice in all user-facing content.\",\n \"allContentGroups\": true,\n \"contentGroupIds\": [\n \"<string>\"\n ],\n \"allLanguages\": true,\n \"languages\": [\n \"<string>\"\n ],\n \"active\": true,\n \"aiCheckEnabled\": true,\n \"forceUnlink\": false\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://eu.phrase.com/styleguide/api/v1/rules/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rule\": \"Avoid passive voice in all user-facing content.\",\n \"allContentGroups\": true,\n \"contentGroupIds\": [\n \"<string>\"\n ],\n \"allLanguages\": true,\n \"languages\": [\n \"<string>\"\n ],\n \"active\": true,\n \"aiCheckEnabled\": true,\n \"forceUnlink\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/styleguide/api/v1/rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rule\": \"Avoid passive voice in all user-facing content.\",\n \"allContentGroups\": true,\n \"contentGroupIds\": [\n \"<string>\"\n ],\n \"allLanguages\": true,\n \"languages\": [\n \"<string>\"\n ],\n \"active\": true,\n \"aiCheckEnabled\": true,\n \"forceUnlink\": false\n}"

response = http.request(request)
puts response.read_body
{
  "id": "01900000-0000-7000-8000-000000000001",
  "rule": "Avoid passive voice in all user-facing content.",
  "active": true,
  "aiCheckEnabled": true,
  "allContentGroups": true,
  "allLanguages": true,
  "contentGroups": [
    {
      "id": "cg-marketing-en"
    }
  ],
  "languages": [
    {
      "bcpCode": "en-GB",
      "description": "English (United Kingdom)",
      "language": "cs",
      "region": "gb",
      "script": "LATN"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "lastModifiedAt": "2024-06-01T14:22:00Z",
  "styleGuide": null,
  "createdBy": null,
  "lastModifiedBy": null
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"detail": "<string>"
}

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

id
string<uuid>
required

Rule ID

Body

application/json

Request to update an existing Rule. Only fields that are present (non-null) in the JSON body are applied.

rule
string

Updated rule text. Changing it would unlink the rule from its Style Guide; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.

Maximum string length: 450
Example:

"Avoid passive voice in all user-facing content."

allContentGroups
boolean

When true, this rule applies to all content groups and contentGroupIds must be absent or empty. When false, contentGroupIds must be provided and non-empty. Null = no change. Changing the content group scope away from the linked Style Guide's content group would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.

contentGroupIds
string[]

Complete replacement of the Content Group IDs this rule applies to. Null = no change. Must be non-empty when allContentGroups is false; must be absent or empty when allContentGroups is true. Any previously set IDs not included here are removed. Removing the linked Style Guide's content group would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.

Maximum array length: 100
Maximum string length: 36
allLanguages
boolean

When true, this rule applies to all languages and languages must be absent or empty. When false, languages must be provided and non-empty. Null = no change. Changing the language scope away from the linked Style Guide's language would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.

languages
string[]

Complete replacement of the language codes this rule applies to. Null = no change. Must be non-empty when allLanguages is false; must be absent or empty when allLanguages is true. Any previously set codes not included here are removed. Removing the linked Style Guide's language would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.

Maximum array length: 100
Minimum string length: 1
active
boolean

Whether this rule is active. Null = no change.

aiCheckEnabled
boolean

Whether this rule is used during AI-powered quality checks. Null = no change.

Confirms that this update may unlink the rule from its currently linked Style Guide. Required (must be true) when a change to rule text, content group scope, or language scope would cause an unlink; otherwise the request fails with 409 CONFLICT and no changes are applied. Default: false.

Response

Rule updated successfully

Rule details

id
string<uuid>
required

Unique identifier for this Rule

Example:

"01900000-0000-7000-8000-000000000001"

rule
string
required

The rule text

Example:

"Avoid passive voice in all user-facing content."

active
boolean
required

Whether this rule is active

aiCheckEnabled
boolean
required

Whether this rule is used during AI-powered quality checks

allContentGroups
boolean
required

Whether this rule applies to all content groups

allLanguages
boolean
required

Whether this rule applies to all languages

contentGroups
object[] | null
required

Content Groups this rule applies to. Empty list means all content groups. Null means no content groups are assigned.

languages
object[] | null
required

Language details for languages this rule applies to. Empty list means all languages. Null means no languages are assigned.

createdAt
string<date-time>
required

When this rule was created

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>
required

When this rule was last modified

Example:

"2024-06-01T14:22:00Z"

styleGuide
null

Style Guide this rule was extracted from. Null when the rule is unlinked — either manually created or subsequently edited.

createdBy
null

User who created this rule

lastModifiedBy
null

User who last modified this rule