Edit a help-center article
curl --request PATCH \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"collection": "<string>",
"body": "<string>",
"published": true,
"aiTrained": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
collection: '<string>',
body: JSON.stringify('<string>'),
published: true,
aiTrained: true
})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}"
payload = {
"title": "<string>",
"collection": "<string>",
"body": "<string>",
"published": True,
"aiTrained": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){}Agents
Edit a help-center article
Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
PATCH
/
workspaces
/
{workspaceId}
/
agents
/
{agentId}
/
support
/
help-center
/
articles
/
{articleId}
Edit a help-center article
curl --request PATCH \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"collection": "<string>",
"body": "<string>",
"published": true,
"aiTrained": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
collection: '<string>',
body: JSON.stringify('<string>'),
published: true,
aiTrained: true
})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/help-center/articles/{articleId}"
payload = {
"title": "<string>",
"collection": "<string>",
"body": "<string>",
"published": True,
"aiTrained": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){}Authorizations
accountBeareraccountSessionlocalAccountSession
Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.
Path Parameters
Minimum string length:
1Minimum string length:
1Minimum string length:
1Body
application/json
Response
Edit a help-center article