Add a new article

POST

/api/v1/accounts/{account_id}/portals/{portal_id}/articles

Help Center

Add a new article to portal

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//portals//articles' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "content": "string",
    "meta": {
        "tags": [
            "article_name"
        ],
        "title": "article title",
        "description": "article description"
    },
    "position": 0,
    "status": [
        "draft",
        "published",
        "archived"
    ],
    "title": "string",
    "slug": "string",
    "views": 0,
    "portal_id": 0,
    "account_id": 0,
    "author_id": 0,
    "category_id": 0,
    "folder_id": 0,
    "associated_article_id": 0
}'

Response Example

200 - Example 1

{
    "id": 0,
    "content": "string",
    "meta": {},
    "position": 0,
    "status": "draft",
    "title": "string",
    "slug": "string",
    "views": 0,
    "portal_id": 0,
    "account_id": 0,
    "author_id": 0,
    "category_id": 0,
    "folder_id": 0,
    "associated_article_id": 0
}

Request

Path Params

account_id

string

required

portal_id

string

required

Body Params application/json; charset=utf-8

content

string

optional

The text content.

meta

object

optional

Use for search

Example:

{"tags":["article_name"],"title":"article title","description":"article description"}

position

integer

optional

article position in category

status

integer

optional

Example:

["draft","published","archived"]

title

string

optional

slug

string

optional

views

integer

optional

portal_id

integer

optional

account_id

integer

optional

author_id

integer

optional

category_id

integer

optional

folder_id

integer

optional

associated_article_id

integer

optional

To associate similar articles to each other, e.g to provide the link for the reference.

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

id

integer

optional

content

string

optional

The text content.

meta

object

optional

position

integer

optional

status

enum<integer>

optional

Allowed values:

draftpublishedarchived

title

string

optional

slug

string

optional

views

integer

optional

portal_id

integer

optional

account_id

integer

optional

author_id

integer

optional

category_id

integer

optional

folder_id

integer

optional

associated_article_id

integer

optional

To associate similar articles to each other, e.g to provide the link for the reference.

🟠403Forbidden

Add a new category

Get Conversation Counts