Skip to main content
PUT
/
products
/
{product_id}
/
docs
/
{doc_id}
Update a tutorial page
curl --request PUT \
  --url http://localhost:3001/portal-api/products/{product_id}/docs/{doc_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Title": "<string>",
  "Status": "<string>",
  "Lede": "<string>",
  "Content": "<string>",
  "Path": "<string>",
  "Categories": [
    1
  ],
  "Tags": [
    1
  ],
  "MarkdownEnabled": true,
  "MarkdownContent": "<string>",
  "PreviewContent": "<string>"
}
'
{
  "ID": 1,
  "Content": "# Title\r\n## Subtitle\r\nContent goes here",
  "MarkdownEnabled": true,
  "Status": "published",
  "Title": "Get started this API Product",
  "Lede": "<string>",
  "Type": "<string>",
  "Path": "<string>",
  "Categories": [
    "<string>"
  ],
  "Tags": [
    "<string>"
  ],
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
product_id
integer
required

UID of an API Product

Example:

1

​
doc_id
integer
required

UID of a tutorial page

Example:

1

Body

application/json
​
Title
string
required

Title of the post

​
Status
string
required

Status of the post (e.g., draft, published)

​
Lede
string

Short summary or lead paragraph of the post

​
Content
string

Full content of the post

​
Path
string

URL path for the post

​
Categories
integer[]

IDs of existing categories to associate with the post

​
Tags
integer[]

IDs of existing tags to associate with the post

​
MarkdownEnabled
boolean

Whether Markdown is enabled for this post

​
MarkdownContent
string

Content of the post in Markdown format, if Markdown is enabled

​
PreviewContent
string

Preview content of the post

Response

OK

​
ID
integer

Unique identifier for the post

Example:

1

​
Content
string

Content of this tutorial page. If MarkdownEnabled is true then content of this tutorial page is treated as Markdown text and as HTML otherwise

Example:

"# Title\r\n## Subtitle\r\nContent goes here"

​
MarkdownEnabled
boolean

Switches content between Markdown and HTML versions

Example:

true

​
Status
enum<string>

Status of the post (e.g., draft, published)

Available options:
published,
draft,
review
Example:

"published"

​
Title
string

Title of the post

Example:

"Get started this API Product"

​
Lede
string

Short summary or lead paragraph of the post

​
Type
string

Type of the post (e.g., article, news)

​
Path
string

URL path for the post

​
Categories
string[]

List of categories associated with the post

​
Tags
string[]

List of tags associated with the post

​
CreatedAt
string

Timestamp of when this post was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
UpdatedAt
string

Timestamp of when this post was last updated

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"