Skip to main content

CollectorUpdate

id object
anyOf
string
name object
anyOf
string
responseLimit object
anyOf
integer
completedResponsesCount object
anyOf
integer
surveyId object
anyOf
integer
type object
anyOf
CollectorType (string)

Collector type enum.

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

openDate object
anyOf
string<date-time>
closeDate object
anyOf
string<date-time>
fromEmail object
anyOf
emailEmail (string)required
name object
anyOf
string
senderId object
anyOf
string
messageText object
anyOf
string
closedMessage object
anyOf
string
showUnsubscribe object
anyOf
boolean
status object
anyOf
CollectorStatus (string)

Collector status enum.

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

createdAt object
anyOf
string<date-time>
updatedAt object
anyOf
string<date-time>
dynamicParameters object
anyOf
object
isActive object
anyOf
boolean
isDeleted object
anyOf
boolean
buttonText object
anyOf
string
provider object
anyOf
WhatsAppProvider (string)
Constant value: glassix
templateId object
anyOf
string
phoneNumber object
anyOf
string
parameters object
anyOf
object
limitByIp object
anyOf
boolean
limitByCookie object
anyOf
boolean
CollectorUpdate
{
"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
}
Was this page helpful?