Skip to main content

Create CES Email channel

POST 
/v1/ces/:survey_id/email

Create CES Email channel

Request​

Path Parameters

    survey_id numberrequired

Body

    contacts

    object[]

    Possible values: <= 2000

  • Array [

    • email stringrequired
    variables object

  • ]

    • contactLists string[]
    sendNow boolean

    Default value: true

    mode string

    Default value: BLAST

    type string

    Default value: EMAIL

    name string

    Default value: Email Share

    delayed string
    schedule string
    customProperties object
    variables object

    questions

    object[]

  • Array [

    • id number
    label stringrequired

  • ]

    • meetingTime string

    properties

    object

    body string
    subject string
    replyEmail string
    fromAddress string
    embed_first_question boolean

    Default value: true

    custom_footer boolean
    custom_footer_value string
    ignoreThrottledContacts boolean

    Default value: true

    reminders

    object[]

  • Array [

    • body string
    subject string
    frequency stringrequired

    Possible values: [Days, Weeks, Months]

    type stringrequired

    Possible values: [NOT_RESPONDED, PARTIALLY_RESPONDED]

    interval numberrequired

    properties

    object

    Properties of the reminder

    embed_first_question booleanrequired
    custom_footer booleanrequired
    custom_footer_value string

  • ]

Responses​

Successful

Schema

    string

Loading...