Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions descriptions/0/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3635,7 +3635,7 @@ paths:
`https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted
and ordered?\n>\n> Articles will be returned in descending order on the `updated_at`
attribute. This means if you need to iterate through results then we'll show
the most recently updated articles first.\n\nRequires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n"
the most recently updated articles first.\n\nRequires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.\n"
responses:
'200':
description: successful
Expand Down Expand Up @@ -3726,7 +3726,7 @@ paths:
\U0001F4D8 Tags are managed separately\n>\n> Tags are returned in article responses
but cannot be set in the request body. To add or remove an article's tags,
use the `POST /articles/{article_id}/tags` and `DELETE /articles/{article_id}/tags/{id}`
endpoints.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n"
endpoints.\n\nRequires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.\n"
responses:
'200':
description: article created
Expand Down Expand Up @@ -3946,7 +3946,7 @@ paths:
description: |
You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Article found
Expand Down Expand Up @@ -4047,7 +4047,7 @@ paths:
request to `https://api.intercom.io/articles/<id>`.\n\n> \U0001F4D8 Tags are managed separately\n>\n> Tags are returned in article responses
but cannot be set in the request body. To add or remove an article's tags,
use the `POST /articles/{article_id}/tags` and `DELETE /articles/{article_id}/tags/{id}`
endpoints.\n\nRequires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.\n"
endpoints.\n\nRequires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.\n"
responses:
'200':
description: successful
Expand Down Expand Up @@ -4334,7 +4334,7 @@ paths:
has no staged draft. An article ID that doesn't exist returns a `404` with
the standard error body.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Article draft found
Expand Down Expand Up @@ -4423,7 +4423,7 @@ paths:
`parent_id`, `folder_id`, `audience_ids`, the AI availability fields or the
scheduling fields, is still validated but not applied, so the live article is left untouched.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Draft staged
Expand Down Expand Up @@ -4541,7 +4541,7 @@ paths:
`{ "errors": [{ "message": "...", "status": 422 }] }`, with no `type`,
`request_id` or `code`. The other `422` errors use the standard error format.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Draft published
Expand Down Expand Up @@ -4688,7 +4688,7 @@ paths:
A `404` has an empty response body, whether the article or its content
isn't found.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Versions found
Expand Down Expand Up @@ -4789,7 +4789,7 @@ paths:
A `404` has an empty response body, whether the article, its content or
the version isn't found.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Version found
Expand Down Expand Up @@ -4858,7 +4858,7 @@ paths:
and the authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -4977,7 +4977,7 @@ paths:
The authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Tag removed
Expand Down Expand Up @@ -5105,7 +5105,7 @@ paths:

If no articles match the search, `data` is an empty array rather than an object.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Search successful
Expand Down Expand Up @@ -7406,7 +7406,7 @@ paths:
description: |
You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Successful
Expand Down Expand Up @@ -7497,7 +7497,7 @@ paths:
description: |
You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections`.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: collection created
Expand Down Expand Up @@ -7597,7 +7597,7 @@ paths:
description: |
You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Collection found
Expand Down Expand Up @@ -7670,7 +7670,7 @@ paths:

`help_center_id` is checked but never applied. It must match the help center of the collection's articles and sub-collections, or the request returns a `400`. A collection with no content rejects any `help_center_id`, so leave it out. Moving a collection to another help center isn't supported.

Requires the `read_write_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: successful
Expand Down Expand Up @@ -7846,7 +7846,7 @@ paths:
description: |
You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_centers/<id>`.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Help Center found
Expand Down Expand Up @@ -7911,7 +7911,7 @@ paths:
description: |
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.

Requires the `read_articles_scope` OAuth scope. Set `Intercom-Version: Preview`.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope. Set `Intercom-Version: Preview`.
responses:
'200':
description: Help Centers found
Expand Down
14 changes: 7 additions & 7 deletions descriptions/2.16/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2557,7 +2557,7 @@ paths:
A draft exists only when a published article has unpublished changes staged
on top of it. Returns `404` when the article has no staged draft.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Article draft found
Expand Down Expand Up @@ -2619,7 +2619,7 @@ paths:
Non-versioned fields like AI availability are ignored, leaving the live
values untouched.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Draft staged
Expand Down Expand Up @@ -2705,7 +2705,7 @@ paths:
omitting it returns `422`. Returns `422` when there is no staged draft to
publish, or when a requested locale has no pending changes.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Draft published
Expand Down Expand Up @@ -2805,7 +2805,7 @@ paths:
and the authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -2917,7 +2917,7 @@ paths:
The authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Tag removed
Expand Down Expand Up @@ -3019,7 +3019,7 @@ paths:
`GET /articles/{article_id}/versions/{id}` to retrieve a single version
with its full content.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Versions found
Expand Down Expand Up @@ -3117,7 +3117,7 @@ paths:
`https://api.intercom.io/articles/<article_id>/versions/<id>`. Returns
the version's full content; the live article remains untouched.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Version found
Expand Down
36 changes: 18 additions & 18 deletions descriptions/2.17/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3816,7 +3816,7 @@ paths:
`https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted
and ordered?\n>\n> Articles will be returned in descending order on the `updated_at`
attribute. This means if you need to iterate through results then we'll show
the most recently updated articles first.\n\nRequires the `read_articles_scope` OAuth scope.\n"
the most recently updated articles first.\n\nRequires the `read_articles_scope` or `create_update_articles` OAuth scope.\n"
responses:
'200':
description: successful
Expand Down Expand Up @@ -3907,7 +3907,7 @@ paths:
\U0001F4D8 Tags are managed separately\n>\n> Tags are returned in article responses
but cannot be set in the request body. To add or remove an article's tags,
use the `POST /articles/{article_id}/tags` and `DELETE /articles/{article_id}/tags/{id}`
endpoints.\n\nRequires the `read_write_articles_scope` OAuth scope.\n"
endpoints.\n\nRequires the `read_write_articles_scope` or `create_update_articles` OAuth scope.\n"
responses:
'200':
description: article created
Expand Down Expand Up @@ -4109,7 +4109,7 @@ paths:
description: |
You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Article found
Expand Down Expand Up @@ -4210,7 +4210,7 @@ paths:
request to `https://api.intercom.io/articles/<id>`.\n\n> \U0001F4D8 Tags are managed separately\n>\n> Tags are returned in article responses
but cannot be set in the request body. To add or remove an article's tags,
use the `POST /articles/{article_id}/tags` and `DELETE /articles/{article_id}/tags/{id}`
endpoints.\n\nRequires the `read_write_articles_scope` OAuth scope.\n"
endpoints.\n\nRequires the `read_write_articles_scope` or `create_update_articles` OAuth scope.\n"
responses:
'200':
description: successful
Expand Down Expand Up @@ -4494,7 +4494,7 @@ paths:
has no staged draft. An article ID that doesn't exist returns a `404` with
the standard error body.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Article draft found
Expand Down Expand Up @@ -4585,7 +4585,7 @@ paths:
scheduling, state and placement notes on the request schema's other fields
do not apply to this endpoint, because those fields are not applied.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Draft staged
Expand Down Expand Up @@ -4703,7 +4703,7 @@ paths:
`{ "errors": [{ "message": "...", "status": 422 }] }`, with no `type`,
`request_id` or `code`. The other `422` errors use the standard error format.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Draft published
Expand Down Expand Up @@ -4824,7 +4824,7 @@ paths:
and the authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -4943,7 +4943,7 @@ paths:
The authenticating teammate must have the `manage_knowledge_base_content`
permission.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Tag removed
Expand Down Expand Up @@ -5048,7 +5048,7 @@ paths:
A `404` has an empty response body, whether the article or its content
isn't found.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Versions found
Expand Down Expand Up @@ -5149,7 +5149,7 @@ paths:
A `404` has an empty response body, whether the article, its content or
the version isn't found.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Version found
Expand Down Expand Up @@ -5258,7 +5258,7 @@ paths:

If no articles match the search, `data` is an empty array rather than an object.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Search successful
Expand Down Expand Up @@ -8496,7 +8496,7 @@ paths:
description: |
You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Successful
Expand Down Expand Up @@ -8587,7 +8587,7 @@ paths:
description: |
You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections`.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: collection created
Expand Down Expand Up @@ -8687,7 +8687,7 @@ paths:
description: |
You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Collection found
Expand Down Expand Up @@ -8760,7 +8760,7 @@ paths:

`help_center_id` is checked but never applied. It must match the help center of the collection's articles and sub-collections, or the request returns a `400`. A collection with no content rejects any `help_center_id`, so leave it out. Moving a collection to another help center isn't supported.

Requires the `read_write_articles_scope` OAuth scope.
Requires the `read_write_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: successful
Expand Down Expand Up @@ -8936,7 +8936,7 @@ paths:
description: |
You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_centers/<id>`.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Help Center found
Expand Down Expand Up @@ -9001,7 +9001,7 @@ paths:
description: |
You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.

Requires the `read_articles_scope` OAuth scope.
Requires the `read_articles_scope` or `create_update_articles` OAuth scope.
responses:
'200':
description: Help Centers found
Expand Down
Loading
Loading