Automation Rules

List inbox automation rules

get
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Query parameters
triggerstring · enumOptional

Rule trigger

Possible values:
enabledbooleanOptional

Rule enabled state

Responses
200

OK

application/json
get
/workspaces/{workspaceId}/inbox/automation/rules
200

OK

Reorder automation rule

patch
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Body
triggerstring · enumRequiredPossible values:
Responses
patch
/workspaces/{workspaceId}/inbox/automation/rules/reorder

No content

Get automation rule

get
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Responses
200

OK

application/json
get
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

Update automation rule

patch
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Body
namestring | nullableOptional
descriptionstring | nullableOptional
enabledboolean | nullableOptional
triggerany ofOptional
string · enumOptionalPossible values:
or
string | nullableOptional
categoryIdstring · uuid | nullableOptional
conditionsany ofOptional
or
Responses
200

OK

application/json
patch
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

Delete automation rule

delete
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Responses
delete
/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

No content

List inbox automation categories

get
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Responses
200

OK

application/json
get
/workspaces/{workspaceId}/inbox/automation/categories
200

OK

Create automation category

post
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Body
namestring · min: 4Required
Responses
post
/workspaces/{workspaceId}/inbox/automation/categories

Reorder automation categories

patch
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Body
Responses
patch
/workspaces/{workspaceId}/inbox/automation/categories/reorder

No content

Update automation category

patch
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Body
namestring · min: 4Required
Responses
200

OK

application/json
patch
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}

Delete automation category

delete
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Responses
delete
/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}

No content

Get current new-item reply configuration.

get
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Responses
200

OK

application/json
get
/workspaces/{workspaceId}/inbox/automation/new-item-reply
200

OK

Update or create new-item reply configuration.

put
Authorizations
AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters
workspaceIdstringRequired
Body
projectIdstring · uuid | nullableRequired
Responses
put
/workspaces/{workspaceId}/inbox/automation/new-item-reply

No content

Last updated

Was this helpful?