Update supplied automation rule fields
curl --request PATCH \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"conditions": {
"keywords": [
"<string>"
],
"channels": []
},
"actions": {
"labelIds": [
"<string>"
],
"teamId": "<string>",
"close": true
},
"enabled": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
conditions: {keywords: ['<string>'], channels: []},
actions: {labelIds: ['<string>'], teamId: '<string>', close: true},
enabled: true
})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId}', 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/{ruleId}"
payload = {
"name": "<string>",
"conditions": {
"keywords": ["<string>"],
"channels": []
},
"actions": {
"labelIds": ["<string>"],
"teamId": "<string>",
"close": True
},
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"workspaceId": "<string>",
"agentId": "<string>",
"name": "<string>",
"trigger": "conversation_created",
"conditions": {
"keywords": [
"<string>"
],
"channels": [
"widget"
]
},
"actions": {
"labelIds": [
"<string>"
],
"teamId": "<string>",
"priority": "low",
"close": true
},
"enabled": true,
"position": 4503599627370495,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Agents
Update supplied automation rule fields
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
/
rules
/
{ruleId}
Update supplied automation rule fields
curl --request PATCH \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"conditions": {
"keywords": [
"<string>"
],
"channels": []
},
"actions": {
"labelIds": [
"<string>"
],
"teamId": "<string>",
"close": true
},
"enabled": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
conditions: {keywords: ['<string>'], channels: []},
actions: {labelIds: ['<string>'], teamId: '<string>', close: true},
enabled: true
})
};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/support/rules/{ruleId}', 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/{ruleId}"
payload = {
"name": "<string>",
"conditions": {
"keywords": ["<string>"],
"channels": []
},
"actions": {
"labelIds": ["<string>"],
"teamId": "<string>",
"close": True
},
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"workspaceId": "<string>",
"agentId": "<string>",
"name": "<string>",
"trigger": "conversation_created",
"conditions": {
"keywords": [
"<string>"
],
"channels": [
"widget"
]
},
"actions": {
"labelIds": [
"<string>"
],
"teamId": "<string>",
"priority": "low",
"close": true
},
"enabled": true,
"position": 4503599627370495,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}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
Update supplied automation rule fields
Minimum string length:
1Minimum string length:
1Minimum string length:
1Available options:
conversation_created, message_received Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
0 <= x <= 9007199254740991Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$