API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Update an article

Example Request & Response (Multilingual Help Center)

$ curl https://api.intercom.io/articles/<id> \
-X PUT \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
-H 'Content-Type: application/json' -d

{
  "title": "New title",
  "translated_content": {
    "es": {
      "title": "Nuevo título",
      "state": "published",
      "body": "<p>Spanish body in html</p>",
      "author_id": "1"
    }
  }
}
HTTP/1.1 200 OK
{
  "id": 1,
  "type": "article",
  "workspace_id": "abcdef",
  "title": "New title",
  "description": "English description",
  "body': "<p>This is the body in html</p>",
  "author_id": 1,
  "state": "published",
  "created_at": 7891011,
  "updated_at": 7892022,
  "url": "http://intercom.test/help/en/articles/3-thanks-for-everything",
  "parent_id": 1,
  "parent_type": "collection",
  "default_locale": "en",
  "translated_content": {
    "type": "article_translated_content",
    "fr": {
      "type": "article_content",
      "title": "Allez les verts",
      "description": "French description",
        "body": "<p>French body in html</p>",
        "author_id": 1,
        "state": "published",
        "created_at": 7891011,
        "updated_at": 7891011,
        "url": "http://intercom.test/help/fr/articles/3-allez-les-verts"
    },
    "es": {
      "type": "article_content",
      "title": "Nuevo título",
      "description": nil,
        "body": <p>Spanish body in html</p>,
        "author_id": 1,
        "state": "published",
        "created_at": 7892022,
        "updated_at": 7892022,
        "url": "http://intercom.test/help/fr/articles/3-allez-les-verts"
    }
  },
  "statistics": {
      "type": "article_statistics",
      "views": 10,
      "conversations": 0,
      "reactions": 8,
      "happy_reaction_percentage": 38,
      "neutral_reaction_percentage": 38,
      "sad_reaction_percentage": 25
  }
}

You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.

Request Path Parameters

ParameterTypeRequired?Description
idStringYesThe unique identifier for the article which is given by Intercom.

Request Body Parameters

AttributeTypeRequired?Description
titleStringNoThe title of the article.
For multilingual articles, this will be the title of the default language's content.
descriptionStringNoThe description of the article.
For multilingual articles, this will be the description of the default language's content.
bodyStringNoThe body of the article in HTML.
For multilingual articles, this will be the body of the default language's content.
author_idStringNoThe 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.
stateStringNoWhether the article will be published or will be a draft.
For multilingual articles, this will be the state of the default language's content.
parent_idStringNoThe id of the article's parent collection or section. An article without this field stands alone.
parent_typeStringNoThe type of parent, which can either be a collection or section.
translated_contentObjectNoAn Article Translated Content Object whereby you can specify multiple multilingual articles to be updated.

Response

This will return an Article model of the article you just updated.