channels

Update a channel

Supported only for LINK, SMS, EMAIL and OFFLINE 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

put/v3/channels/{id}

Request

  • Base URL
    https://api.surveysparrow.com
  • URL
    https://api.surveysparrow.com/v3/channels/{id}
  • Auth
    none declared

Path parameters

idnumber required

Id of the channel

Request body

namestring

Name of the channel

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

Mode of the channel, not required when type is LINK

survey_idnumber required

Id of the survey

contact_list_idsnumber[]

Id's of Contact Lists

variablesProperties
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

activeboolean

Set True for Activating the channel, Set False for Pausing the channel

Example request

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

Response

Successful

Changes

No operation changes recorded.