Body_create_collector_collector__post

collector_in objectrequired

id object

anyOf

• string
• null

string

nameName (string)required

responseLimit object

anyOf

• integer
• null

integer

completedResponsesCount object

anyOf

• integer
• null

integer

surveyIdSurveyid (integer)required

typeCollectorType (string)required

Collector type enum.

Possible values: [SMS, EMAIL, WEB_LINK, WHATSAPP, WIDGET]

openDate object

anyOf

• string<date-time>
• null

string<date-time>

closeDate object

anyOf

• string<date-time>
• null

string<date-time>

fromEmail object

anyOf

• EmailDomainEmail
• null

emailEmail (string)required

name object

anyOf

• string
• null

string

senderId object

anyOf

• string
• null

string

messageText object

anyOf

• string
• null

string

closedMessage object

anyOf

• string
• null

string

showUnsubscribe object

anyOf

• boolean
• null

boolean

status object

anyOf

• CollectorStatus
• null

CollectorStatus (string)

Collector status enum.

Possible values: [OPEN, CLOSED, DRAFT, DELETED, INACTIVE, SCHEDULED, RESPONSE_LIMIT_EXCEEDED]

createdAt object

anyOf

• string<date-time>
• null

string<date-time>

updatedAt object

anyOf

• string<date-time>
• null

string<date-time>

dynamicParameters object

anyOf

• object
• null

object

isActiveIsactive (boolean)

Default value: true

isDeleted object

anyOf

• boolean
• null

boolean

buttonText object

anyOf

• string
• null

string

provider object

anyOf

• WhatsAppProvider
• null

WhatsAppProvider (string)

Constant value: glassix

templateId object

anyOf

• string
• integer
• null

string

phoneNumber object

anyOf

• string
• null

string

parameters object

anyOf

• object
• null

object

limitByIpLimitbyip (boolean)

Default value: true

limitByCookieLimitbycookie (boolean)

Default value: true

groupIds object

anyOf

• integer[]
• null

Array [

integer

]

customId object

anyOf

• string
• null

string

contacts object

anyOf

• object[]
• null

Array [

contact object

anyOf

• ContactCreate
• null

id object

anyOf

• integer
• null

integer

firstName object

anyOf

• string
• null

string

lastName object

anyOf

• string
• null

string

email object

anyOf

• string
• null

string

phone object

anyOf

• string
• null

string

externalId object

anyOf

• string
• null

string

departmentId object

anyOf

• string<uuid>
• null

string<uuid>

dynamicParameters object

anyOf

• object
• null

object

]

rules_in object

anyOf

• object[]
• null

Array [

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

]

]

Body_create_collector_collector__post

{
  "collector_in": {
    "id": "string",
    "name": "string",
    "responseLimit": 0,
    "completedResponsesCount": 0,
    "surveyId": 0,
    "type": "SMS",
    "openDate": "2024-07-29T15:51:28.071Z",
    "closeDate": "2024-07-29T15:51:28.071Z",
    "fromEmail": {
      "email": "string",
      "name": "string"
    },
    "senderId": "string",
    "messageText": "string",
    "closedMessage": "string",
    "showUnsubscribe": true,
    "status": "OPEN",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "dynamicParameters": {},
    "isActive": true,
    "isDeleted": true,
    "buttonText": "string",
    "provider": "glassix",
    "templateId": "string",
    "phoneNumber": "string",
    "parameters": {},
    "limitByIp": true,
    "limitByCookie": true,
    "groupIds": [
      0
    ],
    "customId": "string",
    "contacts": [
      {
        "contact": {
          "id": 0,
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "externalId": "string",
          "departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "dynamicParameters": {}
      }
    ]
  },
  "rules_in": [
    {
      "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
          }
        }
      ]
    }
  ]
}