Skip to main content

Create a channel

POST 
/v3/channels

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

Request​

Body

    type stringrequired

    Possible values: [EMAIL, SMS, LINK, OFFLINE]

    Type of the channel

    mode string

    Possible values: [BLAST, RECURRING, RELATIVE_RECURRING]

    Default value: BLAST

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

    channel_id number

    Deprecated, please use update channel instead

    contacts

    object[]

    Possible values: >= 1, <= 20000

  • Array [

    • email string

    Email ID of the contact, required when type is EMAIL

    mobile string

    Mobile number in E.164 format, required when type is SMS

    variables object

  • ]

    • contact_list_ids number[]

    Possible values: >= 1, <= 20

    variables object
    survey_id numberrequired

    Id of the survey

    name stringrequired

    Name of the channel

    send_after_date date

    Timestamp at which survey should be sent

    send_after_days number

    Possible values: >= 1

    Number of days after which survey should be shared

    schedule

    object

    frequency string

    Possible values: [WEEKLY, MONTHLY, YEARLY]

    config

    object

    h number[]required

    Possible values: >= 1

    m number[]required

    Possible values: >= 1

    d string[]required

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7], >= 1

    relative_schedule

    object

    first_nps

    object

    delay numberrequired

    Possible values: >= 1

    Delay after which first survey to be shared

    unit stringrequired

    Possible values: [Days, Months]

    Unit of the delay

    contact_property_id numberrequired

    Id of the contact property, only DATE type contact properties are allowed

    after_first_nps_schedule string

    Possible values: [NONE, EVERY_45_DAYS, EVERY_3_MONTHS, EVERY_6_MONTHS, EVERY_1_YEAR]

    Repetition of survey sharing after first share

    reminders

    object[]

    Array of reminders

  • Array [

    • subject string

    Subject of the reminder, both {company_name} and {survey_link} variables are required when channel type is SMS

    body string

    Body of the reminder. Not required for SMS channel type. Note:Placeholders are supported for Customer Experience (CX) surveys only.

    type stringrequired

    Possible values: [NOT_RESPONDED, PARTIALLY_RESPONDED]

    Type of the responders

    interval numberrequired

    Possible values: >= 1

    Delay after which reminder to be sent

    frequency stringrequired

    Possible values: [Days, Weeks, Months]

    Unit of the delay

    properties

    object

    Properties of the reminder

    embed_first_question booleanrequired
    custom_footer booleanrequired
    custom_footer_value string

  • ]

    • sms

    object

    Only required when type is SMS

    message string

    Possible values: <= 140 characters

    Message of sms, both {company_name} and {survey_link} variables are required.

    twilio_consent_agreed boolean

    For using SurveySparrow message service you need to agree the consent

    target_id number

    Id of the custom target, default target will be taken if not given

    email

    object

    subject string

    Subject of the email

    properties

    object

    body string

    Body of the email

    from_address string

    From address of the email

    embed_first_question booleanrequired
    custom_footer boolean
    custom_footer_value string

    Custom footer value

    show_surveysparrow_branding booleanrequired

    Set true to show SurveySparrow branding on email

    reply_to stringrequired

    Reply to address of the email

    theme_id number

    Id of the email theme

    link

    object

    title string

    Title of the weblink channel

    description string

    Description of the web link channel

    image_link string

    Image link of the weblink channel, provide link for a JPEG or PNG image. Get best results when the image is 1200 x 630 pixels

    offline

    object

    animation_direction string

    Possible values: [Horizontal, Vertical]

    Animation Direction of the offline channel

    ignore_throttled_contacts boolean

    Default value: true

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

    accept_anonymous_response boolean

    Only applicable for CX survey types

Responses​

Successful

Schema

    data

    object

    id number

    Id of channel

    name string

    Name of channel

    status string

    Status of the share

    type string

    Type of channel

    properties object
Loading...