Dry-run rule conditions against recent conversations without applying them
curl --request POST \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conditions": {
"keywords": [
"<string>"
],
"channels": []
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({conditions: {keywords: ['<string>'], channels: []}})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/preview', 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/rules/preview"
payload = { "conditions": {
"keywords": ["<string>"],
"channels": []
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"matched": 4503599627370495,
"scanned": 4503599627370495,
"days": 123
}Agents
Dry-run rule conditions against recent conversations without applying them
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.
POST
/
workspaces
/
{workspaceId}
/
agents
/
{agentId}
/
support
/
rules
/
preview
Dry-run rule conditions against recent conversations without applying them
curl --request POST \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conditions": {
"keywords": [
"<string>"
],
"channels": []
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({conditions: {keywords: ['<string>'], channels: []}})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/preview', 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/rules/preview"
payload = { "conditions": {
"keywords": ["<string>"],
"channels": []
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"matched": 4503599627370495,
"scanned": 4503599627370495,
"days": 123
}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:
1Body
application/json