Skip to main content
PATCH
Update rule

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

ruleID
string
required

Body

application/json
name
string

Rule name

Example:

"Pending to closed"

description
string

Rule description

Example:

"Set ticket to closed after 3 days when pending"

ordering
integer

Rule execution order

Example:

100

quantifier
enum<string>
Available options:
all,
any
active
boolean

Is rule active

triggers
object[]
actions
object[]

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

name
string

The rule name.

description
string

The rule description.

type
enum<string>

The rules domain.

Available options:
tickets
ordering
integer

The rule execution order.

active
boolean

Is rule active.

quantifier
enum<string>
Available options:
all,
any
triggers
object[]
actions
object[]
useCounter
number

The rule use counter.