Skip to main content
POST
Create an automation rule at the end of the run order

Authorizations

Authorization
string
header
required

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

workspaceId
string
required
Minimum string length: 1
agentId
string
required
Minimum string length: 1

Body

application/json
name
string
required
Required string length: 1 - 80
trigger
enum<string>
required
Available options:
conversation_created,
message_received
conditions
object
required
actions
object
required
enabled
boolean

Response

Create an automation rule at the end of the run order

id
string
required
Minimum string length: 1
workspaceId
string
required
Minimum string length: 1
agentId
string
required
Minimum string length: 1
name
string
required
trigger
enum<string>
required
Available options:
conversation_created,
message_received
conditions
object
required
actions
object
required
enabled
boolean
required
position
integer
required
Required range: 0 <= x <= 9007199254740991
createdAt
string<date-time>
required
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)))$
updatedAt
string<date-time>
required
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)))$
firesThisWeek
number
required