CMS · FAQ
8 routes. Paths are relative to https://api.intersink.com/v1.
- GET/cms/channels/{channelId}/faq/categoriesList the channel's FAQ categories
- POST/cms/channels/{channelId}/faq/categoriesCreate a FAQ category (max 3 levels deep)
- PATCH/cms/channels/{channelId}/faq/categories/{groupId}Update / move a FAQ category
- DELETE/cms/channels/{channelId}/faq/categories/{groupId}Delete an empty FAQ category
- GET/cms/channels/{channelId}/faq/itemsList the channel's FAQs (all statuses)
- POST/cms/channels/{channelId}/faq/itemsCreate a FAQ (answer is sanitized HTML)
- PATCH/cms/channels/{channelId}/faq/items/{faqId}Update a FAQ (incl. publish/unpublish via status)
- DELETE/cms/channels/{channelId}/faq/items/{faqId}Delete a FAQ
List the channel's FAQ categories
GET/cms/channels/{channelId}/faq/categories
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. data is object[].
Create a FAQ category (max 3 levels deep)
POST/cms/channels/{channelId}/faq/categories
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| slug | string | At most 120 characters. Example: "bookings" |
| type | string | Audience type At most 60 characters. Example: "business" |
| parent_id | number | Parent category id (same channel) Minimum 1. |
| description | string | At most 2000 characters. |
| namerequired | string | At most 255 characters. Example: "Bookings" |
Response
201. The payload in data is of type object.
Update / move a FAQ category
PATCH/cms/channels/{channelId}/faq/categories/{groupId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| groupIdrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| slug | string | At most 120 characters. Example: "bookings" |
| type | string | Audience type At most 60 characters. Example: "business" |
| parent_id | number | Parent category id (same channel) Minimum 1. |
| description | string | At most 2000 characters. |
| name | string | At most 255 characters. |
Response
200. The payload in data is of type object.
Delete an empty FAQ category
DELETE/cms/channels/{channelId}/faq/categories/{groupId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| groupIdrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
List the channel's FAQs (all statuses)
GET/cms/channels/{channelId}/faq/items
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| status | string, query | One of: "draft", "published", "archived". |
| q | string, query | Search in the title/name |
| group_id | number, query | Only this category Minimum 1. |
Response
200. The payload in data is not described in the spec yet.
Create a FAQ (answer is sanitized HTML)
POST/cms/channels/{channelId}/faq/items
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| description | string | Answer as rich text, sanitized server-side At most 20000 characters. |
| slug | string | At most 120 characters. Example: "how-do-i-reschedule" |
| sort | number | Minimum 0, maximum 10000. |
| faq_group_idrequired | number | Category (faq_group) id of this channel Minimum 1. |
| titlerequired | string | At most 255 characters. Example: "How do I reschedule?" |
| status | string | One of: "draft", "published". |
Response
201. The payload in data is of type object.
Update a FAQ (incl. publish/unpublish via status)
PATCH/cms/channels/{channelId}/faq/items/{faqId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| faqIdrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| description | string | Answer as rich text, sanitized server-side At most 20000 characters. |
| slug | string | At most 120 characters. Example: "how-do-i-reschedule" |
| sort | number | Minimum 0, maximum 10000. |
| faq_group_id | number | Minimum 1. |
| title | string | At most 255 characters. |
| status | string | One of: "draft", "published", "archived". |
Response
200. The payload in data is of type object.
Delete a FAQ
DELETE/cms/channels/{channelId}/faq/items/{faqId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| faqIdrequired | number, path |
Response
200. The payload in data is not described in the spec yet.