Create a rule

post

https://{domain}.gorgias.com/api/rules

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

code

string

required

The logic of the rule (as JavaScript code).

code_ast

object

The logic of the rule (as an ESTree AST representation). Generated from the code if not specified.

deactivated_datetime

date-time | null

When the rule was deactivated.

description

string | null

The description of the rule.

event_types

string

enum

A list of comma separated events that this rule will be executed on.

Allowed:

name

string

required

The name of the rule.

priority

integer

Order of execution of the rule. Rules with higher priorities are executed first.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created rule.