Update doc article

Update docs article

curl --request PATCH \
  --url https://productlane.com/api/v2/docs/articles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "allow_image_removal": true,
  "summary": "<string>",
  "published": true,
  "archived": true,
  "show_on_home_page": true,
  "group_id": "<string>",
  "portal_instance_id": "<string>",
  "icon": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://productlane.com/api/v2/docs/articles/{id}"

payload = {
    "title": "<string>",
    "content": "<string>",
    "allow_image_removal": True,
    "summary": "<string>",
    "published": True,
    "archived": True,
    "show_on_home_page": True,
    "group_id": "<string>",
    "portal_instance_id": "<string>",
    "icon": "<string>",
    "language": "<string>"
}
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({
    title: '<string>',
    content: '<string>',
    allow_image_removal: true,
    summary: '<string>',
    published: true,
    archived: true,
    show_on_home_page: true,
    group_id: '<string>',
    portal_instance_id: '<string>',
    icon: '<string>',
    language: '<string>'
  })
};

fetch('https://productlane.com/api/v2/docs/articles/{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://productlane.com/api/v2/docs/articles/{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([
    'title' => '<string>',
    'content' => '<string>',
    'allow_image_removal' => true,
    'summary' => '<string>',
    'published' => true,
    'archived' => true,
    'show_on_home_page' => true,
    'group_id' => '<string>',
    'portal_instance_id' => '<string>',
    'icon' => '<string>',
    'language' => '<string>'
  ]),
  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://productlane.com/api/v2/docs/articles/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\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://productlane.com/api/v2/docs/articles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://productlane.com/api/v2/docs/articles/{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  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "url_name": "<string>",
  "published": true,
  "external_url": "<string>",
  "archived": true,
  "show_on_home_page": true,
  "image_url": "<string>",
  "group_id": "<string>",
  "portal_instance_id": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

PATCH

docs

articles

{id}

Update docs article

curl --request PATCH \
  --url https://productlane.com/api/v2/docs/articles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "allow_image_removal": true,
  "summary": "<string>",
  "published": true,
  "archived": true,
  "show_on_home_page": true,
  "group_id": "<string>",
  "portal_instance_id": "<string>",
  "icon": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://productlane.com/api/v2/docs/articles/{id}"

payload = {
    "title": "<string>",
    "content": "<string>",
    "allow_image_removal": True,
    "summary": "<string>",
    "published": True,
    "archived": True,
    "show_on_home_page": True,
    "group_id": "<string>",
    "portal_instance_id": "<string>",
    "icon": "<string>",
    "language": "<string>"
}
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({
    title: '<string>',
    content: '<string>',
    allow_image_removal: true,
    summary: '<string>',
    published: true,
    archived: true,
    show_on_home_page: true,
    group_id: '<string>',
    portal_instance_id: '<string>',
    icon: '<string>',
    language: '<string>'
  })
};

fetch('https://productlane.com/api/v2/docs/articles/{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://productlane.com/api/v2/docs/articles/{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([
    'title' => '<string>',
    'content' => '<string>',
    'allow_image_removal' => true,
    'summary' => '<string>',
    'published' => true,
    'archived' => true,
    'show_on_home_page' => true,
    'group_id' => '<string>',
    'portal_instance_id' => '<string>',
    'icon' => '<string>',
    'language' => '<string>'
  ]),
  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://productlane.com/api/v2/docs/articles/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\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://productlane.com/api/v2/docs/articles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://productlane.com/api/v2/docs/articles/{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  \"title\": \"<string>\",\n  \"content\": \"<string>\",\n  \"allow_image_removal\": true,\n  \"summary\": \"<string>\",\n  \"published\": true,\n  \"archived\": true,\n  \"show_on_home_page\": true,\n  \"group_id\": \"<string>\",\n  \"portal_instance_id\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "url_name": "<string>",
  "published": true,
  "external_url": "<string>",
  "archived": true,
  "show_on_home_page": true,
  "image_url": "<string>",
  "group_id": "<string>",
  "portal_instance_id": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

title

string

Minimum string length: 1

content

string

Markdown body. Replaces the whole body, so carry over every image, table and embed the article already has.

Minimum string length: 1

allow_image_removal

boolean

Defaults to false, which rejects a body that leaves out an image the article still has. Set to true to delete those images.

summary

string

published

boolean

visibility

enum<string>

Unlisted articles stay off your docs site and out of portal search. The Productlane Agent answers customers from them, and never links them.

Available options:

public,

unlisted

archived

boolean

show_on_home_page

boolean

group_id

string | null

Pass null to detach the article from any group.

portal_instance_id

string | null

Portal instance id to assign, from GET /portal/instances. null or omitted targets the Main (Root) portal.

icon

string

Nucleo icon name in PascalCase.

Required string length: 1 - 64

language

string

BCP-47 language code. When set, translatable fields upsert a translation row; non-translatable fields always apply to the base.

Response

Successful response

string

required

created_at

string

required

updated_at

string

required

title

string

required

summary

string

required

content

string

required

icon

string

required

Name of a Nucleo icon (PascalCase, e.g. Notepad, Atom). Must be a valid icon from https://nucleoapp.com - unknown names will not render in the dashboard or portal.

url_name

string

required

published

boolean

required

visibility

enum<string>

required

Unlisted articles stay off your docs site and out of portal search. The Productlane Agent answers customers from them, and never links them.

Available options:

public,

unlisted

kind

enum<string>

required

link rows point at a page you host elsewhere: content is empty and external_url holds the address.

Available options:

doc,

link

external_url

string | null

required

archived

boolean

required

show_on_home_page

boolean

required

image_url

string | null

required

group_id

string | null

required

portal_instance_id

string | null

required

API Documentation

Endpoints

Authorizations

Path Parameters

Body

Response