Change Bottom Pinned Related Articles

Overview

API to change bottom pinned related articles.

Permissions

  • User must have 'Edit Article' Permission to change pinned related article of an article.
  • The articles being pinned must be related articles.
  • Article must be checked out first
SecurityoAuthUser
Request
path Parameters
ID
required
string

The ID of the article for which the operation is performed. Both numeric and alternate ID formats are supported.

Examples:
A readable article ID.
PROD-2268
A numeric article ID.
202200000002268
Request Body schema: application/json
id
number

response must have id

name
string non-empty

response must have name

isWebArticle
boolean

response must have isWebArticle flag

object

response must have link

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/articles/{ID}/related/pintobottom
Request samples
application/json
{
  • "pinnedRelatedArticle": [
    ]
}
Response samples
application/json

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}