Sign in

v1

latestSwagger 2.02026-08-06250450289.0 KB
channels

Create a channel

schedule, relative_schedule only required when mode is RECURRING, RELATIVE_RECURRING respectively and sms, email, link properties only required when type is SMS, EMAIL, LINK and animation_direction can be provided when type is OFFLINE

post/v3/channels

Request body

type'EMAIL' | 'SMS' | 'LINK' | 'OFFLINE' required

Type of the channel

mode'BLAST' | 'RECURRING' | 'RELATIVE_RECURRING'

Mode of the channel, not required when type is LINK and OFFLINE

channel_idnumber

Deprecated, please use update channel instead

contact_list_idsnumber[]
variablesProperties
survey_idnumber required

Id of the survey

namestring required

Name of the channel

send_after_datestring date

Timestamp at which survey should be sent

send_after_daysnumber

Number of days after which survey should be shared

ignore_throttled_contactsboolean

If set to true, survey will be shared even if throttling is met

accept_anonymous_responseboolean

Only applicable for CX survey types

Example request

{
  "contacts": [
    {
      "referenceId": "123456"
    }
  ]
}

Response

Successful