RuleCreate

id object

anyOf

• integer
• null

integer

operator object

anyOf

• string
• null

string

isActive object

anyOf

• boolean
• null

boolean

collectorId object

anyOf

• string
• null

string

conditions object[]required

Array [

id object

anyOf

• integer
• null

integer

ruleId object

anyOf

• integer
• null

integer

value object

anyOf

• string
• null

string

typeConditionTypes (string)required

Possible values: [Survey Opened, Survey Completed, Survey Score Below, Survey Score Above, Survey Score Below Percentage, Survey Score Above Percentage]

]

actions object[]required

Array [

id object

anyOf

• integer
• null

integer

ruleId object

anyOf

• integer
• null

integer

type object

anyOf

• ActionType
• null

ActionType (string)

Action type enum.

Possible values: [Coupon, Email, SMS, WhatsApp, Coupon Email, Coupon SMS, Coupon WhatsApp]

parameters object

anyOf

• EmailActionParameters
• SMSActionParameters
• CouponActionParameters
• WhatsAppActionParameters
• null

fromEmail objectrequired

emailEmail (string)required

name object

anyOf

• string
• null

string

subjectSubject (string)required

bodyBody (string)required

recipientRecipient (string)

Default value: surveyFiller

couponGroupId object

anyOf

• integer
• null

integer

]

RuleCreate

{
  "id": 0,
  "operator": "string",
  "isActive": true,
  "collectorId": "string",
  "conditions": [
    {
      "id": 0,
      "ruleId": 0,
      "value": "string",
      "type": "Survey Opened"
    }
  ],
  "actions": [
    {
      "id": 0,
      "ruleId": 0,
      "type": "Coupon",
      "parameters": {
        "fromEmail": {
          "email": "string",
          "name": "string"
        },
        "subject": "string",
        "body": "string",
        "recipient": "surveyFiller",
        "couponGroupId": 0
      }
    }
  ]
}