CollectorRead

idId (string)required

nameName (string)required

responseLimit object

anyOf

• integer
• null

integer

completedResponsesCountCompletedresponsescount (integer)required

surveyId object

anyOf

• integer
• null

integer

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

statusCollectorStatus (string)required

Collector status enum.

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

createdAtstring<date-time>required

updatedAtstring<date-time>required

dynamicParameters object

anyOf

• object
• null

object

isActiveIsactive (boolean)required

isDeletedIsdeleted (boolean)required

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)required

limitByCookieLimitbycookie (boolean)required

surveyTitle object

anyOf

• string
• null

string

groups object

anyOf

• object[]
• null

Array [

idId (integer)required

nameName (string)required

departmentId object

anyOf

• string<uuid>
• null

string<uuid>

organizationId object

anyOf

• string<uuid>
• null

string<uuid>

createdAtstring<date-time>required

]

CollectorRead

{
  "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,
  "surveyTitle": "string",
  "groups": [
    {
      "id": 0,
      "name": "string",
      "departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-07-29T15:51:28.071Z"
    }
  ]
}