Update an internal article

Request

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

Security

bearerAuth

Path

idintegerrequired

The unique identifier for the internal article which is given by Intercom.

Example:123

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.14"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.14

Bodyapplication/json

titlestring

The title of the article.

Example:"Thanks for everything"

bodystring

The content of the article.

author_idinteger

The id of the author of the article.

Example:1295

owner_idinteger

The id of the author of the article.

Example:1295

curl -i -X PUT \
  https://api.intercom.io/internal_articles/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "title": "Christmas is here!",
    "body": "<p>New gifts in store for the jolly season</p>"
  }'

Responses

successful

Bodyapplication/json

typestring

The type of object - internal_article.

Default:"internal_article"

Value:"internal_article"

Example:"internal_article"

idstring

The unique identifier for the article which is given by Intercom.

Example:"6871119"

titlestring

The title of the article.

bodystring or null

The body of the article in HTML.

Example:"Default language body in html"

owner_idinteger

The id of the owner of the article.

Example:"5017691"

author_idinteger

The id of the author of the article.

Example:"5017691"

created_atinteger, (date-time)

The time when the article was created.

Example:1672928359

updated_atinteger, (date-time)

The time when the article was last updated.

Example:1672928610

localestring

The default locale of the article.

Example:"en"

Response

{
  "id": "48",
  "body": "Body of the Article",
  "owner_id": 991266252,
  "author_id": 991266252,
  "locale": "en"
}