Update Knowledge Base Page
CUSTOM-ENDPOINT
PUT https://api.speakap.io/networks/:eid/pages/:eid/
CUSTOM-REQUEST
- URI: /networks/{networkEID}/pages/{pageEID}
- Method: PUT
- Accept: application/vnd.speakap.api-v1.8.2+json+hal
- Authentication: OAuth 2.0
Parameters
| Name | Type | Description |
|---|
| networkEID | EID | Network EID |
| pageEID | EID | Page EID |
Request Body
Supply a knowledge base page resource in the request body.
| Name | Type | Description |
|---|
| title | string | Title of page. It's a required field. |
| body | html | The body of page. It's a required field. |
| icon | string | The name of the icon of the page. It's a required field. |
| status | string | The status of the page. Published or draft. It's a required field. |
| pageType | string | The type of the page. It must be knowledge_base. It's a required field. |
| knowledgeBaseCategory | array | A list of categories. Although it's a list, should be a list of a single element. It's a required field |
| recipients | array | List of recipient objects (groups or network). It's a required field |
| recipients[i].EID | EID | EID of the recipient (group or network) |
| recipients[i].type | string | group or network |
| coverImage | messageIdentity | A cover image for the page. It's optional |
| coverImage.EID | EID | EID of the uploaded file |
| coverImage.type | string | message |
Example (knowledge base page)
{
"body": "The body here",
"icon": "car",
"recipients": [
{
"EID": "{{NetworkEID}}",
"type": "network"
}
],
"knowledgeBaseCategories": ["{{CategoryEID}}"],
"title": "Auto",
"status": "published",
"pageType": "knowledge_base",
"coverImage": {
"EID": "{{FileEID}}",
"type": "message"
}
}
Response