Skip to main content
Support

Update an article

PATCH https://api.helpdocs.io/v1/article/{article_id}

Example request

Generated
Parameters
curl -X PATCH 'https://api.helpdocs.io/v1/article/string?working_copy=true' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "string",
    "category_id": "string",
    "show_toc": true,
    "is_private": true,
    "is_published": true,
    "is_featured": true,
    "related_article_ids": [
      "string"
    ],
    "related_auto": true,
    "is_archived": true,
    "archive_reason": "string",
    "icon": "string",
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "short_version": "string",
    "body": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "is_live": true,
    "editor_type": "string",
    "machine_translated_at": "2024-01-15T09:30:00Z",
    "expected_content_token": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "short_version": "string",
        "body": "string",
        "slug": "string",
        "tags": [
          "string"
        ],
        "is_live": true,
        "editor_type": "string",
        "machine_translated_at": "2024-01-15T09:30:00Z",
        "expected_content_token": "string"
      }
    ],
    "stale_status": {
      "is_stale": true,
      "source": "string",
      "reason": "string",
      "expires_at": "2024-01-15T09:30:00Z"
    }
  }'
curl -X PATCH https://api.helpdocs.io/v1/article/string \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
const url = "https://api.helpdocs.io/v1/article/string?working_copy=true";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "user_id": "string",
    "category_id": "string",
    "show_toc": true,
    "is_private": true,
    "is_published": true,
    "is_featured": true,
    "related_article_ids": [
      "string"
    ],
    "related_auto": true,
    "is_archived": true,
    "archive_reason": "string",
    "icon": "string",
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "short_version": "string",
    "body": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "is_live": true,
    "editor_type": "string",
    "machine_translated_at": "2024-01-15T09:30:00Z",
    "expected_content_token": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "short_version": "string",
        "body": "string",
        "slug": "string",
        "tags": [
          "string"
        ],
        "is_live": true,
        "editor_type": "string",
        "machine_translated_at": "2024-01-15T09:30:00Z",
        "expected_content_token": "string"
      }
    ],
    "stale_status": {
      "is_stale": true,
      "source": "string",
      "reason": "string",
      "expires_at": "2024-01-15T09:30:00Z"
    }
  }),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article/string";

const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article/string?working_copy=true";

const options: RequestInit = {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "user_id": "string",
    "category_id": "string",
    "show_toc": true,
    "is_private": true,
    "is_published": true,
    "is_featured": true,
    "related_article_ids": [
      "string"
    ],
    "related_auto": true,
    "is_archived": true,
    "archive_reason": "string",
    "icon": "string",
    "permission_groups": [
      "string"
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "short_version": "string",
    "body": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "is_live": true,
    "editor_type": "string",
    "machine_translated_at": "2024-01-15T09:30:00Z",
    "expected_content_token": "string",
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "short_version": "string",
        "body": "string",
        "slug": "string",
        "tags": [
          "string"
        ],
        "is_live": true,
        "editor_type": "string",
        "machine_translated_at": "2024-01-15T09:30:00Z",
        "expected_content_token": "string"
      }
    ],
    "stale_status": {
      "is_stale": true,
      "source": "string",
      "reason": "string",
      "expires_at": "2024-01-15T09:30:00Z"
    }
  }),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
const url = "https://api.helpdocs.io/v1/article/string";

const options: RequestInit = {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
};

const response = await fetch(url, options);

const data: unknown = await response.json();
console.log(data);
import requests

url = "https://api.helpdocs.io/v1/article/string"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

params = {
    "working_copy": "true",
}

payload = {
    "user_id": "string",
    "category_id": "string",
    "show_toc": True,
    "is_private": True,
    "is_published": True,
    "is_featured": True,
    "related_article_ids": [
        "string",
    ],
    "related_auto": True,
    "is_archived": True,
    "archive_reason": "string",
    "icon": "string",
    "permission_groups": [
        "string",
    ],
    "language_code": "string",
    "title": "string",
    "description": "string",
    "short_version": "string",
    "body": "string",
    "slug": "string",
    "tags": [
        "string",
    ],
    "is_live": True,
    "editor_type": "string",
    "machine_translated_at": "2024-01-15T09:30:00Z",
    "expected_content_token": "string",
    "multilingual": [
        {
            "language_code": "string",
            "title": "string",
            "description": "string",
            "short_version": "string",
            "body": "string",
            "slug": "string",
            "tags": [
                "string",
            ],
            "is_live": True,
            "editor_type": "string",
            "machine_translated_at": "2024-01-15T09:30:00Z",
            "expected_content_token": "string",
        },
    ],
    "stale_status": {
        "is_stale": True,
        "source": "string",
        "reason": "string",
        "expires_at": "2024-01-15T09:30:00Z",
    },
}

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

print(response.json())
import requests

url = "https://api.helpdocs.io/v1/article/string"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json",
}

payload = {}

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

print(response.json())
<?php

$ch = curl_init("https://api.helpdocs.io/v1/article/string?working_copy=true");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "user_id" => "string",
        "category_id" => "string",
        "show_toc" => true,
        "is_private" => true,
        "is_published" => true,
        "is_featured" => true,
        "related_article_ids" => [
            "string",
        ],
        "related_auto" => true,
        "is_archived" => true,
        "archive_reason" => "string",
        "icon" => "string",
        "permission_groups" => [
            "string",
        ],
        "language_code" => "string",
        "title" => "string",
        "description" => "string",
        "short_version" => "string",
        "body" => "string",
        "slug" => "string",
        "tags" => [
            "string",
        ],
        "is_live" => true,
        "editor_type" => "string",
        "machine_translated_at" => "2024-01-15T09:30:00Z",
        "expected_content_token" => "string",
        "multilingual" => [
            [
                "language_code" => "string",
                "title" => "string",
                "description" => "string",
                "short_version" => "string",
                "body" => "string",
                "slug" => "string",
                "tags" => [
                    "string",
                ],
                "is_live" => true,
                "editor_type" => "string",
                "machine_translated_at" => "2024-01-15T09:30:00Z",
                "expected_content_token" => "string",
            ],
        ],
        "stale_status" => [
            "is_stale" => true,
            "source" => "string",
            "reason" => "string",
            "expires_at" => "2024-01-15T09:30:00Z",
        ],
    ]),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
<?php

$ch = curl_init("https://api.helpdocs.io/v1/article/string");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_TOKEN",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode(new stdClass()),
]);

$response = curl_exec($ch);

print_r(json_decode($response, true));
package main

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

func main() {
	body := strings.NewReader(`{
  "user_id": "string",
  "category_id": "string",
  "show_toc": true,
  "is_private": true,
  "is_published": true,
  "is_featured": true,
  "related_article_ids": [
    "string"
  ],
  "related_auto": true,
  "is_archived": true,
  "archive_reason": "string",
  "icon": "string",
  "permission_groups": [
    "string"
  ],
  "language_code": "string",
  "title": "string",
  "description": "string",
  "short_version": "string",
  "body": "string",
  "slug": "string",
  "tags": [
    "string"
  ],
  "is_live": true,
  "editor_type": "string",
  "machine_translated_at": "2024-01-15T09:30:00Z",
  "expected_content_token": "string",
  "multilingual": [
    {
      "language_code": "string",
      "title": "string",
      "description": "string",
      "short_version": "string",
      "body": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "is_live": true,
      "editor_type": "string",
      "machine_translated_at": "2024-01-15T09:30:00Z",
      "expected_content_token": "string"
    }
  ],
  "stale_status": {
    "is_stale": true,
    "source": "string",
    "reason": "string",
    "expires_at": "2024-01-15T09:30:00Z"
  }
}`)

	req, err := http.NewRequest(http.MethodPatch, "https://api.helpdocs.io/v1/article/string?working_copy=true", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
package main

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

func main() {
	body := strings.NewReader("{}")

	req, err := http.NewRequest(http.MethodPatch, "https://api.helpdocs.io/v1/article/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/article/string?working_copy=true"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {
                  "user_id": "string",
                  "category_id": "string",
                  "show_toc": true,
                  "is_private": true,
                  "is_published": true,
                  "is_featured": true,
                  "related_article_ids": [
                    "string"
                  ],
                  "related_auto": true,
                  "is_archived": true,
                  "archive_reason": "string",
                  "icon": "string",
                  "permission_groups": [
                    "string"
                  ],
                  "language_code": "string",
                  "title": "string",
                  "description": "string",
                  "short_version": "string",
                  "body": "string",
                  "slug": "string",
                  "tags": [
                    "string"
                  ],
                  "is_live": true,
                  "editor_type": "string",
                  "machine_translated_at": "2024-01-15T09:30:00Z",
                  "expected_content_token": "string",
                  "multilingual": [
                    {
                      "language_code": "string",
                      "title": "string",
                      "description": "string",
                      "short_version": "string",
                      "body": "string",
                      "slug": "string",
                      "tags": [
                        "string"
                      ],
                      "is_live": true,
                      "editor_type": "string",
                      "machine_translated_at": "2024-01-15T09:30:00Z",
                      "expected_content_token": "string"
                    }
                  ],
                  "stale_status": {
                    "is_stale": true,
                    "source": "string",
                    "reason": "string",
                    "expires_at": "2024-01-15T09:30:00Z"
                  }
                }"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.helpdocs.io/v1/article/string"))
            .header("Authorization", "Bearer YOUR_TOKEN")
            .header("Content-Type", "application/json")
            .method("PATCH", HttpRequest.BodyPublishers.ofString("""
                {}"""))
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/article/string?working_copy=true")

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "user_id" => "string",
  "category_id" => "string",
  "show_toc" => true,
  "is_private" => true,
  "is_published" => true,
  "is_featured" => true,
  "related_article_ids" => [
    "string",
  ],
  "related_auto" => true,
  "is_archived" => true,
  "archive_reason" => "string",
  "icon" => "string",
  "permission_groups" => [
    "string",
  ],
  "language_code" => "string",
  "title" => "string",
  "description" => "string",
  "short_version" => "string",
  "body" => "string",
  "slug" => "string",
  "tags" => [
    "string",
  ],
  "is_live" => true,
  "editor_type" => "string",
  "machine_translated_at" => "2024-01-15T09:30:00Z",
  "expected_content_token" => "string",
  "multilingual" => [
    {
      "language_code" => "string",
      "title" => "string",
      "description" => "string",
      "short_version" => "string",
      "body" => "string",
      "slug" => "string",
      "tags" => [
        "string",
      ],
      "is_live" => true,
      "editor_type" => "string",
      "machine_translated_at" => "2024-01-15T09:30:00Z",
      "expected_content_token" => "string",
    },
  ],
  "stale_status" => {
    "is_stale" => true,
    "source" => "string",
    "reason" => "string",
    "expires_at" => "2024-01-15T09:30:00Z",
  },
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
require "json"
require "net/http"

uri = URI("https://api.helpdocs.io/v1/article/string")

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Content-Type"] = "application/json"
request.body = JSON.generate({})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

pp JSON.parse(response.body)
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.helpdocs.io/v1/article/string?working_copy=true");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {
      "user_id": "string",
      "category_id": "string",
      "show_toc": true,
      "is_private": true,
      "is_published": true,
      "is_featured": true,
      "related_article_ids": [
        "string"
      ],
      "related_auto": true,
      "is_archived": true,
      "archive_reason": "string",
      "icon": "string",
      "permission_groups": [
        "string"
      ],
      "language_code": "string",
      "title": "string",
      "description": "string",
      "short_version": "string",
      "body": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "is_live": true,
      "editor_type": "string",
      "machine_translated_at": "2024-01-15T09:30:00Z",
      "expected_content_token": "string",
      "multilingual": [
        {
          "language_code": "string",
          "title": "string",
          "description": "string",
          "short_version": "string",
          "body": "string",
          "slug": "string",
          "tags": [
            "string"
          ],
          "is_live": true,
          "editor_type": "string",
          "machine_translated_at": "2024-01-15T09:30:00Z",
          "expected_content_token": "string"
        }
      ],
      "stale_status": {
        "is_stale": true,
        "source": "string",
        "reason": "string",
        "expires_at": "2024-01-15T09:30:00Z"
      }
    }
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());
using System.Text;

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.helpdocs.io/v1/article/string");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
request.Content = new StringContent(
    """
    {}
    """,
    Encoding.UTF8,
    "application/json");

var response = await client.SendAsync(request);

Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

{
  "article": {
    "article_id": "string",
    "account_id": "string",
    "user_id": "string",
    "category_id": "string",
    "author": {
      "name": "string",
      "email": "string",
      "profile_image": "string"
    },
    "title": "string",
    "description": "string",
    "short_version": "string",
    "body": "string",
    "slug": "string",
    "icon": "string",
    "tags": [
      "string"
    ],
    "show_toc": true,
    "is_private": true,
    "is_published": true,
    "is_archived": true,
    "status": "string",
    "archived_at": "2024-01-15T09:30:00Z",
    "archived_by": "string",
    "archive_reason": "string",
    "is_featured": true,
    "related_article_ids": [
      "string"
    ],
    "related_auto": true,
    "is_current_version": true,
    "version_number": 1,
    "source": "string",
    "external_id": "string",
    "editor_type": "string",
    "stale_status": {
      "is_stale": true,
      "reason": "string",
      "source": "string",
      "triggered_at": "2024-01-15T09:30:00Z",
      "expires_at": "2024-01-15T09:30:00Z"
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "permission_groups": [
      "string"
    ],
    "multilingual": [
      {
        "language_code": "string",
        "title": "string",
        "description": "string",
        "short_version": "string",
        "body": "string",
        "slug": "string",
        "tags": [
          "string"
        ],
        "user_id": "string",
        "url": "string",
        "relative_url": "string",
        "is_live": true,
        "is_current_version": true,
        "version_number": 1,
        "editor_type": "string",
        "machine_translated_at": "2024-01-15T09:30:00Z",
        "has_working_copy": true,
        "created_at": "2024-01-15T09:30:00Z",
        "content_token": "string"
      }
    ],
    "url": "string",
    "relative_url": "string",
    "description_was_autogenerated": true,
    "short_version_was_autogenerated": true
  },
  "articles": [
    {
      "article_id": "string",
      "account_id": "string",
      "user_id": "string",
      "category_id": "string",
      "author": {
        "name": "string",
        "email": "string",
        "profile_image": "string"
      },
      "title": "string",
      "description": "string",
      "short_version": "string",
      "body": "string",
      "slug": "string",
      "icon": "string",
      "tags": [
        "string"
      ],
      "show_toc": true,
      "is_private": true,
      "is_published": true,
      "is_archived": true,
      "status": "string",
      "archived_at": "2024-01-15T09:30:00Z",
      "archived_by": "string",
      "archive_reason": "string",
      "is_featured": true,
      "related_article_ids": [
        "string"
      ],
      "related_auto": true,
      "is_current_version": true,
      "version_number": 1,
      "source": "string",
      "external_id": "string",
      "editor_type": "string",
      "stale_status": {
        "is_stale": true,
        "reason": "string",
        "source": "string",
        "triggered_at": "2024-01-15T09:30:00Z",
        "expires_at": "2024-01-15T09:30:00Z"
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "permission_groups": [
        "string"
      ],
      "multilingual": [
        {
          "language_code": "string",
          "title": "string",
          "description": "string",
          "short_version": "string",
          "body": "string",
          "slug": "string",
          "tags": [
            "string"
          ],
          "user_id": "string",
          "url": "string",
          "relative_url": "string",
          "is_live": true,
          "is_current_version": true,
          "version_number": 1,
          "editor_type": "string",
          "machine_translated_at": "2024-01-15T09:30:00Z",
          "has_working_copy": true,
          "created_at": "2024-01-15T09:30:00Z",
          "content_token": "string"
        }
      ],
      "url": "string",
      "relative_url": "string",
      "description_was_autogenerated": true,
      "short_version_was_autogenerated": true
    }
  ]
}

Every article the update touched.

Schemas
string

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

Schemas
{
  "code": 1,
  "err": "string"
}

Authentication failed or no API key was supplied.

Schemas
{
  "code": 1,
  "err": "string"
}

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

Schemas
{
  "code": 1,
  "err": "string"
}

The key lacks write permission, or the account’s plan does not include API access.

Schemas
string

No such resource in this account, or article_id does not match the pattern this route accepts.

Schemas
string

An article in the request has been saved since the content_token you sent, so it was not changed, or the article is archived or needs an approved review. On a multi-id update the other articles may have been written: articles lists them.

Schemas
{
  "code": 1,
  "err": "string"
}

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

Schemas
Generated

Updates the supplied fields and leaves the rest untouched. The path accepts a comma-separated list of article ids to apply the same change to several articles at once.

To make sure you are not overwriting somebody else’s newer save, send back the content_token you read, as expected_content_token (top level for the default language, on a multilingual entry for the others) or in an If-Match header. If anyone has saved that language since, working copies included, the article is left unchanged and the request answers 409. Read the article again and reapply your change. Without either, the update applies as it always has. A guarded update answers with the new content_token of each article it wrote.

A token guards a language’s content, so it must name a language the update writes: top-level fields write the default language, a multilingual entry writes its own. One that guards nothing the update writes, such as a token sent with only article fields (category_id, is_published, is_featured) or a default-language token sent with only a translation’s entry, is refused with 400. If a working copy is pending, the live version’s token is refused with 409: read with working_copy=true and send that token to replace the working copy.

Authentication

    • ApiKeyBearer http bearer

      An API key sent as Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.

    • OAuth2 oauth2

      An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.

      Scopes write:articles

Path parameters

  • article_id string Required

    pattern ^([0-9a-zA-Z]{10},?){1,}$

Query parameters

  • working_copy boolean

    Save to the unpublished working copy instead of publishing the change.

Header parameters

  • If-Match string

    One or more comma-separated entity-tags of the form “::”, as the ETag header of a single-article read gives them. Each guards that language of that article, so one header can guard every article of a multi-id update. A tag for an article not in the path is refused with 400, as is a header whose only tags for an article name languages the request does not write: top-level fields are the default language’s, a translation’s changes go in a multilingual entry, and an update of article fields alone writes no language.

Request body Required

The fields to change. Anything omitted is left as it is.

application/json UpdateArticleRequest
  • user_id string Nullable

    Null is the same as leaving the field out.

  • category_id string Nullable

    Null is the same as leaving the field out.

  • show_toc boolean Nullable

    Null is the same as leaving the field out.

  • is_private boolean Nullable

    Null is the same as leaving the field out.

  • is_published boolean Nullable

    Null is the same as leaving the field out.

  • is_featured boolean Nullable

    Null is the same as leaving the field out.

  • related_article_ids array of string Nullable

    Null is the same as leaving the field out.

  • related_auto boolean Nullable

    Null is the same as leaving the field out.

  • is_archived boolean Nullable

    Null is the same as leaving the field out.

  • archive_reason string Nullable

    Null is the same as leaving the field out.

  • icon string Nullable

    Null is the same as leaving the field out.

  • permission_groups array of string Nullable

    Null is the same as leaving the field out.

  • language_code string
  • title string Nullable

    Null is the same as leaving the field out.

  • description string Nullable

    Null is the same as leaving the field out.

  • short_version string Nullable

    Null is the same as leaving the field out.

  • body string Nullable

    Null is the same as leaving the field out.

  • slug string Nullable

    Null is the same as leaving the field out.

  • tags array of string Nullable

    Null is the same as leaving the field out.

  • is_live boolean Nullable

    Null is the same as leaving the field out.

  • editor_type string Nullable

    Null is the same as leaving the field out.

  • machine_translated_at string (date-time) Nullable

    Null is the same as leaving the field out.

  • expected_content_token string Nullable

    Null is the same as leaving the field out.

  • multilingual array of UpdateArticleVersion Nullable

    Null is the same as leaving the field out.

  • stale_status UpdateArticleStaleStatus Nullable

    Null is the same as leaving the field out.

{
  "user_id": "string",
  "category_id": "string",
  "show_toc": true,
  "is_private": true,
  "is_published": true,
  "is_featured": true,
  "related_article_ids": [
    "string"
  ],
  "related_auto": true,
  "is_archived": true,
  "archive_reason": "string",
  "icon": "string",
  "permission_groups": [
    "string"
  ],
  "language_code": "string",
  "title": "string",
  "description": "string",
  "short_version": "string",
  "body": "string",
  "slug": "string",
  "tags": [
    "string"
  ],
  "is_live": true,
  "editor_type": "string",
  "machine_translated_at": "2024-01-15T09:30:00Z",
  "expected_content_token": "string",
  "multilingual": [
    {
      "language_code": "string",
      "title": "string",
      "description": "string",
      "short_version": "string",
      "body": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "is_live": true,
      "editor_type": "string",
      "machine_translated_at": "2024-01-15T09:30:00Z",
      "expected_content_token": "string"
    }
  ],
  "stale_status": {
    "is_stale": true,
    "source": "string",
    "reason": "string",
    "expires_at": "2024-01-15T09:30:00Z"
  }
}

Generated from the schema

Responses

200

Every article the update touched.

application/json ArticleUpdatedResponse
  • article Article Required Nullable
  • articles array of Article Required
400

The request was rejected: a required field is missing from the body, or a value in it is not acceptable.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

401

Authentication failed or no API key was supplied.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

402

The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

403

The key lacks write permission, or the account’s plan does not include API access.

application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

404

No such resource in this account, or article_id does not match the pattern this route accepts.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

409

An article in the request has been saved since the content_token you sent, so it was not changed, or the article is archived or needs an approved review. On a multi-id update the other articles may have been written: articles lists them.

text/plain

The failure, as a human-readable message.

  • string

    The failure, as a human-readable message.

429

Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.

headers

  • Retry-After integer
  • X-RateLimit-Limit integer
  • X-RateLimit-Remaining integer
  • X-RateLimit-Reset integer
application/json Error

An error response.

  • code integer Required

    The HTTP status code.

  • err string Required

    A human-readable description of the failure.

All endpoints