POST /articles

You can create a new article by making a POST request to https://api.intercom.io/articles.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Intercom-Version String No

Possible values:

  • "1.1"
  • "2.0"
  • "1.0"
  • "2.9"
  • "Unstable"
  • "1.3"
  • "2.2"
  • "2.12"
  • "1.2"
  • "2.1"
  • "2.4"
  • "1.4"
  • "2.3"
  • "2.6"
  • "2.5"
  • "2.8"
  • "2.10"
  • "2.7"
  • "2.11"

Default value: "2.12"

Request body fields

Name Type Required Description
parent_id Integer No

The id of the article's parent collection or section. An article without this field stands alone.

description String No

The description of the article. For multilingual articles, this will be the description of the default language's content.

translated_content Object No

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

translated_content.fr Object No

The Content of an Article.

translated_content.fr.description String No

The description of the article.

translated_content.fr.url String No

The URL of the article.

translated_content.fr.author_id Integer No

The ID of the author of the article.

translated_content.fr.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.fr.title String No

The title of the article.

translated_content.fr.body String No

The body of the article.

translated_content.fr.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.fr.created_at Integer No

The time when the article was created (seconds).

translated_content.fr.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.hu Object No

The Content of an Article.

translated_content.hu.description String No

The description of the article.

translated_content.hu.url String No

The URL of the article.

translated_content.hu.author_id Integer No

The ID of the author of the article.

translated_content.hu.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.hu.title String No

The title of the article.

translated_content.hu.body String No

The body of the article.

translated_content.hu.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.hu.created_at Integer No

The time when the article was created (seconds).

translated_content.hu.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.bs Object No

The Content of an Article.

translated_content.bs.description String No

The description of the article.

translated_content.bs.url String No

The URL of the article.

translated_content.bs.author_id Integer No

The ID of the author of the article.

translated_content.bs.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.bs.title String No

The title of the article.

translated_content.bs.body String No

The body of the article.

translated_content.bs.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.bs.created_at Integer No

The time when the article was created (seconds).

translated_content.bs.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.sl Object No

The Content of an Article.

translated_content.sl.description String No

The description of the article.

translated_content.sl.url String No

The URL of the article.

translated_content.sl.author_id Integer No

The ID of the author of the article.

translated_content.sl.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.sl.title String No

The title of the article.

translated_content.sl.body String No

The body of the article.

translated_content.sl.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.sl.created_at Integer No

The time when the article was created (seconds).

translated_content.sl.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.id Object No

The Content of an Article.

translated_content.id.description String No

The description of the article.

translated_content.id.url String No

The URL of the article.

translated_content.id.author_id Integer No

The ID of the author of the article.

translated_content.id.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.id.title String No

The title of the article.

translated_content.id.body String No

The body of the article.

translated_content.id.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.id.created_at Integer No

The time when the article was created (seconds).

translated_content.id.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.zh-TW Object No

The Content of an Article.

translated_content.zh-TW.description String No

The description of the article.

translated_content.zh-TW.url String No

The URL of the article.

translated_content.zh-TW.author_id Integer No

The ID of the author of the article.

translated_content.zh-TW.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.zh-TW.title String No

The title of the article.

translated_content.zh-TW.body String No

The body of the article.

translated_content.zh-TW.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.zh-TW.created_at Integer No

The time when the article was created (seconds).

translated_content.zh-TW.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.ca Object No

The Content of an Article.

translated_content.ca.description String No

The description of the article.

translated_content.ca.url String No

The URL of the article.

translated_content.ca.author_id Integer No

The ID of the author of the article.

translated_content.ca.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ca.title String No

The title of the article.

translated_content.ca.body String No

The body of the article.

translated_content.ca.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ca.created_at Integer No

The time when the article was created (seconds).

translated_content.ca.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.sr Object No

The Content of an Article.

translated_content.sr.description String No

The description of the article.

translated_content.sr.url String No

The URL of the article.

translated_content.sr.author_id Integer No

The ID of the author of the article.

translated_content.sr.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.sr.title String No

The title of the article.

translated_content.sr.body String No

The body of the article.

translated_content.sr.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.sr.created_at Integer No

The time when the article was created (seconds).

translated_content.sr.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.mn Object No

The Content of an Article.

translated_content.mn.description String No

The description of the article.

translated_content.mn.url String No

The URL of the article.

translated_content.mn.author_id Integer No

The ID of the author of the article.

translated_content.mn.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.mn.title String No

The title of the article.

translated_content.mn.body String No

The body of the article.

translated_content.mn.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.mn.created_at Integer No

The time when the article was created (seconds).

translated_content.mn.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.sv Object No

The Content of an Article.

translated_content.sv.description String No

The description of the article.

translated_content.sv.url String No

The URL of the article.

translated_content.sv.author_id Integer No

The ID of the author of the article.

translated_content.sv.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.sv.title String No

The title of the article.

translated_content.sv.body String No

The body of the article.

translated_content.sv.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.sv.created_at Integer No

The time when the article was created (seconds).

translated_content.sv.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.type String No

The type of object - article_translated_content.

Possible values:

  • null
  • "article_translated_content"
translated_content.ko Object No

The Content of an Article.

translated_content.ko.description String No

The description of the article.

translated_content.ko.url String No

The URL of the article.

translated_content.ko.author_id Integer No

The ID of the author of the article.

translated_content.ko.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ko.title String No

The title of the article.

translated_content.ko.body String No

The body of the article.

translated_content.ko.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ko.created_at Integer No

The time when the article was created (seconds).

translated_content.ko.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.el Object No

The Content of an Article.

translated_content.el.description String No

The description of the article.

translated_content.el.url String No

The URL of the article.

translated_content.el.author_id Integer No

The ID of the author of the article.

translated_content.el.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.el.title String No

The title of the article.

translated_content.el.body String No

The body of the article.

translated_content.el.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.el.created_at Integer No

The time when the article was created (seconds).

translated_content.el.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.en Object No

The Content of an Article.

translated_content.en.description String No

The description of the article.

translated_content.en.url String No

The URL of the article.

translated_content.en.author_id Integer No

The ID of the author of the article.

translated_content.en.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.en.title String No

The title of the article.

translated_content.en.body String No

The body of the article.

translated_content.en.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.en.created_at Integer No

The time when the article was created (seconds).

translated_content.en.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.it Object No

The Content of an Article.

translated_content.it.description String No

The description of the article.

translated_content.it.url String No

The URL of the article.

translated_content.it.author_id Integer No

The ID of the author of the article.

translated_content.it.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.it.title String No

The title of the article.

translated_content.it.body String No

The body of the article.

translated_content.it.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.it.created_at Integer No

The time when the article was created (seconds).

translated_content.it.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.es Object No

The Content of an Article.

translated_content.es.description String No

The description of the article.

translated_content.es.url String No

The URL of the article.

translated_content.es.author_id Integer No

The ID of the author of the article.

translated_content.es.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.es.title String No

The title of the article.

translated_content.es.body String No

The body of the article.

translated_content.es.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.es.created_at Integer No

The time when the article was created (seconds).

translated_content.es.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.et Object No

The Content of an Article.

translated_content.et.description String No

The description of the article.

translated_content.et.url String No

The URL of the article.

translated_content.et.author_id Integer No

The ID of the author of the article.

translated_content.et.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.et.title String No

The title of the article.

translated_content.et.body String No

The body of the article.

translated_content.et.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.et.created_at Integer No

The time when the article was created (seconds).

translated_content.et.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.cs Object No

The Content of an Article.

translated_content.cs.description String No

The description of the article.

translated_content.cs.url String No

The URL of the article.

translated_content.cs.author_id Integer No

The ID of the author of the article.

translated_content.cs.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.cs.title String No

The title of the article.

translated_content.cs.body String No

The body of the article.

translated_content.cs.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.cs.created_at Integer No

The time when the article was created (seconds).

translated_content.cs.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.ar Object No

The Content of an Article.

translated_content.ar.description String No

The description of the article.

translated_content.ar.url String No

The URL of the article.

translated_content.ar.author_id Integer No

The ID of the author of the article.

translated_content.ar.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ar.title String No

The title of the article.

translated_content.ar.body String No

The body of the article.

translated_content.ar.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ar.created_at Integer No

The time when the article was created (seconds).

translated_content.ar.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.vi Object No

The Content of an Article.

translated_content.vi.description String No

The description of the article.

translated_content.vi.url String No

The URL of the article.

translated_content.vi.author_id Integer No

The ID of the author of the article.

translated_content.vi.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.vi.title String No

The title of the article.

translated_content.vi.body String No

The body of the article.

translated_content.vi.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.vi.created_at Integer No

The time when the article was created (seconds).

translated_content.vi.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.nb Object No

The Content of an Article.

translated_content.nb.description String No

The description of the article.

translated_content.nb.url String No

The URL of the article.

translated_content.nb.author_id Integer No

The ID of the author of the article.

translated_content.nb.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.nb.title String No

The title of the article.

translated_content.nb.body String No

The body of the article.

translated_content.nb.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.nb.created_at Integer No

The time when the article was created (seconds).

translated_content.nb.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.ja Object No

The Content of an Article.

translated_content.ja.description String No

The description of the article.

translated_content.ja.url String No

The URL of the article.

translated_content.ja.author_id Integer No

The ID of the author of the article.

translated_content.ja.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ja.title String No

The title of the article.

translated_content.ja.body String No

The body of the article.

translated_content.ja.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ja.created_at Integer No

The time when the article was created (seconds).

translated_content.ja.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.pl Object No

The Content of an Article.

translated_content.pl.description String No

The description of the article.

translated_content.pl.url String No

The URL of the article.

translated_content.pl.author_id Integer No

The ID of the author of the article.

translated_content.pl.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.pl.title String No

The title of the article.

translated_content.pl.body String No

The body of the article.

translated_content.pl.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.pl.created_at Integer No

The time when the article was created (seconds).

translated_content.pl.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.pt-BR Object No

The Content of an Article.

translated_content.pt-BR.description String No

The description of the article.

translated_content.pt-BR.url String No

The URL of the article.

translated_content.pt-BR.author_id Integer No

The ID of the author of the article.

translated_content.pt-BR.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.pt-BR.title String No

The title of the article.

translated_content.pt-BR.body String No

The body of the article.

translated_content.pt-BR.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.pt-BR.created_at Integer No

The time when the article was created (seconds).

translated_content.pt-BR.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.da Object No

The Content of an Article.

translated_content.da.description String No

The description of the article.

translated_content.da.url String No

The URL of the article.

translated_content.da.author_id Integer No

The ID of the author of the article.

translated_content.da.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.da.title String No

The title of the article.

translated_content.da.body String No

The body of the article.

translated_content.da.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.da.created_at Integer No

The time when the article was created (seconds).

translated_content.da.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.he Object No

The Content of an Article.

translated_content.he.description String No

The description of the article.

translated_content.he.url String No

The URL of the article.

translated_content.he.author_id Integer No

The ID of the author of the article.

translated_content.he.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.he.title String No

The title of the article.

translated_content.he.body String No

The body of the article.

translated_content.he.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.he.created_at Integer No

The time when the article was created (seconds).

translated_content.he.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.ro Object No

The Content of an Article.

translated_content.ro.description String No

The description of the article.

translated_content.ro.url String No

The URL of the article.

translated_content.ro.author_id Integer No

The ID of the author of the article.

translated_content.ro.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ro.title String No

The title of the article.

translated_content.ro.body String No

The body of the article.

translated_content.ro.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ro.created_at Integer No

The time when the article was created (seconds).

translated_content.ro.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.nl Object No

The Content of an Article.

translated_content.nl.description String No

The description of the article.

translated_content.nl.url String No

The URL of the article.

translated_content.nl.author_id Integer No

The ID of the author of the article.

translated_content.nl.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.nl.title String No

The title of the article.

translated_content.nl.body String No

The body of the article.

translated_content.nl.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.nl.created_at Integer No

The time when the article was created (seconds).

translated_content.nl.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.tr Object No

The Content of an Article.

translated_content.tr.description String No

The description of the article.

translated_content.tr.url String No

The URL of the article.

translated_content.tr.author_id Integer No

The ID of the author of the article.

translated_content.tr.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.tr.title String No

The title of the article.

translated_content.tr.body String No

The body of the article.

translated_content.tr.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.tr.created_at Integer No

The time when the article was created (seconds).

translated_content.tr.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.de Object No

The Content of an Article.

translated_content.de.description String No

The description of the article.

translated_content.de.url String No

The URL of the article.

translated_content.de.author_id Integer No

The ID of the author of the article.

translated_content.de.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.de.title String No

The title of the article.

translated_content.de.body String No

The body of the article.

translated_content.de.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.de.created_at Integer No

The time when the article was created (seconds).

translated_content.de.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.fi Object No

The Content of an Article.

translated_content.fi.description String No

The description of the article.

translated_content.fi.url String No

The URL of the article.

translated_content.fi.author_id Integer No

The ID of the author of the article.

translated_content.fi.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.fi.title String No

The title of the article.

translated_content.fi.body String No

The body of the article.

translated_content.fi.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.fi.created_at Integer No

The time when the article was created (seconds).

translated_content.fi.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.ru Object No

The Content of an Article.

translated_content.ru.description String No

The description of the article.

translated_content.ru.url String No

The URL of the article.

translated_content.ru.author_id Integer No

The ID of the author of the article.

translated_content.ru.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.ru.title String No

The title of the article.

translated_content.ru.body String No

The body of the article.

translated_content.ru.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.ru.created_at Integer No

The time when the article was created (seconds).

translated_content.ru.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.zh-CN Object No

The Content of an Article.

translated_content.zh-CN.description String No

The description of the article.

translated_content.zh-CN.url String No

The URL of the article.

translated_content.zh-CN.author_id Integer No

The ID of the author of the article.

translated_content.zh-CN.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.zh-CN.title String No

The title of the article.

translated_content.zh-CN.body String No

The body of the article.

translated_content.zh-CN.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.zh-CN.created_at Integer No

The time when the article was created (seconds).

translated_content.zh-CN.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.pt Object No

The Content of an Article.

translated_content.pt.description String No

The description of the article.

translated_content.pt.url String No

The URL of the article.

translated_content.pt.author_id Integer No

The ID of the author of the article.

translated_content.pt.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.pt.title String No

The title of the article.

translated_content.pt.body String No

The body of the article.

translated_content.pt.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.pt.created_at Integer No

The time when the article was created (seconds).

translated_content.pt.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.bg Object No

The Content of an Article.

translated_content.bg.description String No

The description of the article.

translated_content.bg.url String No

The URL of the article.

translated_content.bg.author_id Integer No

The ID of the author of the article.

translated_content.bg.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.bg.title String No

The title of the article.

translated_content.bg.body String No

The body of the article.

translated_content.bg.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.bg.created_at Integer No

The time when the article was created (seconds).

translated_content.bg.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.lt Object No

The Content of an Article.

translated_content.lt.description String No

The description of the article.

translated_content.lt.url String No

The URL of the article.

translated_content.lt.author_id Integer No

The ID of the author of the article.

translated_content.lt.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.lt.title String No

The title of the article.

translated_content.lt.body String No

The body of the article.

translated_content.lt.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.lt.created_at Integer No

The time when the article was created (seconds).

translated_content.lt.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.hr Object No

The Content of an Article.

translated_content.hr.description String No

The description of the article.

translated_content.hr.url String No

The URL of the article.

translated_content.hr.author_id Integer No

The ID of the author of the article.

translated_content.hr.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.hr.title String No

The title of the article.

translated_content.hr.body String No

The body of the article.

translated_content.hr.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.hr.created_at Integer No

The time when the article was created (seconds).

translated_content.hr.updated_at Integer No

The time when the article was last updated (seconds).

translated_content.lv Object No

The Content of an Article.

translated_content.lv.description String No

The description of the article.

translated_content.lv.url String No

The URL of the article.

translated_content.lv.author_id Integer No

The ID of the author of the article.

translated_content.lv.type String No

The type of object - article_content .

Possible values:

  • null
  • "article_content"
translated_content.lv.title String No

The title of the article.

translated_content.lv.body String No

The body of the article.

translated_content.lv.state String No

Whether the article is published or is a draft .

Possible values:

  • "published"
  • "draft"
translated_content.lv.created_at Integer No

The time when the article was created (seconds).

translated_content.lv.updated_at Integer No

The time when the article was last updated (seconds).

author_id Integer Yes

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

parent_type String No

The type of parent, which can either be a collection or section.

title String Yes

The title of the article.For multilingual articles, this will be the title of the default language's content.

body String No

The content of the article. For multilingual articles, this will be the body of the default language's content.

state String No

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

Possible values:

  • "published"
  • "draft"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.