Schedule Mute API

What does muting a schedule do?

Muting a schedule prevents pings from being sent from that schedule to your participant, but keeps the schedule applied to the paticipant. Muting is done on a participant-by-participant basis, and is independent of the schedule's global settings. For example, if you have a schedule set to send pings every 10 minutes and you mute it for a participant, that participant will not receive any pings from that schedule until it is unmuted. Other participants on the same schedule will continue to receive pings as normal.

Muting a schedule is different from deactivating a schedule. When you deactivate a schedule, it is removed from the participant's schedule list which means, when you re-activate that schedule, it will start at "Day 1". Unmuting a muted schedule will resume the schedule from where the participant would be had the schedule not been muted.

How to set up your survey to interact with Inclivio's Schedule Mute API

The following example shows you how to achieve this using the web service feature in Qualtrics.

1. Capture the pingid survey parameter as embedded data

   

2. Add a New Element Here > Web Service

   

3. Add the following information:

   • Method: POST
   • URL: https://incliv.io/surveyCallback
   

4. Select Add a body parameter to send to web service

   

5. Set the parameter as pingid and the value as ${e://Field/pingid} (this is equivalent to Insert Piped Text > Embedded Data Field > pingid).

   

6. Add a second body parameter by pressing the button. Add your project's API key (found in Project > Settings > Project API Key). Set the parameter as api-key and the value as your project's API key.

   

7. Add a third body parameter to the Web Service. Set the parameter as scheduleid and the value as the schedule ID you wish to mute or unmute. You can find your schedule ID in the schedule page, Settings tab.

   

8. Add a fourth parameter to the Web Service. Set the parameter as muted and the value as true to mute the schedule, or false to unmute the schedule.

   To mute the schedule:To unmute the schedule:

9. Select an optional reset time. You can reset your mute or unmute after a specified period of time, or at a specific time of day.

   To reset the mute/unmute after a specific period of time, add an additional body paramter called muted-reset-time and the value as an integer, representing the number of minutes after which you would like your action to reset. This is optional. If a reset time is not sepcific, the action (i.e., mute or unmute) will remain in place until manually reset.

   For example, if you would like to mute a schedule for 30 minutes, you would create the following Web Service:

   

To unmute a schedule for 30 minutes, you would create the same Web Service, except with muted set to false:



To reset at a specific time of day, add an additional body paramter called muted-reset-time and the value as the time of day in 24-hour format: HH:MM. For example, if you wish to reset your action at 5:30 PM, you would set your muted-reset-time parameter to 17:30. If you wish to reset your action at 11:00 AM, you would set your muted-reset-time parameter to 11:00.



If the ping is clicked after the reset time has passed, the action will reset at that time the following day. For example, if the reset time is set to 11:00 AM and the ping is clicked at 11:30 AM, the action will reset at 11:00 AM the following day.

If both a reset time in minutes and a reset time of day are specified, the earlier of the two will take precedence. For example, if you set muted-reset-minutes to 30 and muted-reset-time to 11:00 PM, and the ping is clicked at 10:45 PM, the action will reset after 15 minutes at 11:00 PM.