Checkbox Survey Software Checkbox Survey Software
  • Features
    • Survey Creation
      Survey question types, logic, merging, and action options.
    • Survey Look & Feel
      Survey customization, branding, and mobile responsiveness.
    • Survey Distribution
      Email invitations, reminders, embed options, and custom links.
    • Security & Permissions
      Survey permissions, sharing options, SSO, and data security.
    • Results & Reporting
      Data export formats, charts & graphs, report filtering and API.
    • Automation & Integration
      Automatic emails & URL redirects, API, and JavaScript.
    • On-Premises Features
      Overview of on-premises version features and architecture.
    • Full Feature List
      Compare all features and limits for hosted and on-premises plans.
  • Pricing
    • Hosted Plans
      Individual, team and enterprise cloud-hosted plans.
    • On-Premises Software
      Perpetual software licenses, installed on your own servers.
    • White Label & OEM
      Learn about integrating Checkbox into your software for resale.
    • Discounts Programs
      Discounts for academic, government and non-profits.
  • About
    • Clients
      View a sampling of our global customers by industry.
    • Blog
      Company news, announcements, and industry articles.
    • Case Studies
      Learn how some of our clients use Checkbox to streamline operations.
  • Contact Us
  • Support
    • Version 7 Help Guides
      Searchable knowledge base for Checkbox Version 7.
    • Legacy (V6) Help Guides
      Searchable knowledge base for Checkbox Version 6.
    • API Docs
      Documentation for working with the Checkbox Version 7 API.
    • Technical Requirements
      Technical requirements for installing Checkbox on-premises.
    • Support Info & Policies
      Customer support hours, holidays, access information, and terms.
    • Support Login
      Login form for Checkbox on-premises support users.
  • 
  • 
    • Sales/General
      +1 (617) 231-8890
    • Support
      +1 (617) 231-8899
  • Sign In
    • US-hosted
      Sign in page for accounts hosted in the US.
    • Canada-hosted
      Sign in page for accounts hosted in Canada.
    • EU-hosted
      Sign in page for accounts hosted in the EU.
    • UK-hosted
      Sign in page for accounts hosted in the UK.
    • Australia-hosted
      Sign in page for accounts hosted in Australia.
    • Support Login
      Login for on-premises support customers.
  • Try it Free
    • Hosted Trial
      Create a 14-day cloud-hosted trial account. US, Canada, EU, UK, & Australia hosting options.
    • On-Premises Trial
      Download a 30-day on-premises trial to install on your own servers (not for PC/laptop installation).
    • Learn More
      Not sure which option to choose? Learn more about our versions.
Homepage / Doc / Add Scheduled Invitation Activity

Add Scheduled Invitation Activity

The AddScheduledInvitationActivity method can be utilized to schedule invitations and reminders to be sent out at some point in the future. This method requires invitation scheduling be enabled, which is enabled by default for all Checkbox Online accounts.

This method will be released with the 2017 Q2 update in June of 2017. This method is currently not available in any previous version.
public partial class InvitationForm : Form
    {
        readonly InvitationManagementServiceClient _invitationManagementServiceClient = new InvitationManagementServiceClient();
        readonly AuthenticationServiceClient _authenticationServiceClient = new AuthenticationServiceClient();
        public InvitationForm()
        {
            InitializeComponent();
        }

        private void btnSend_Click(object sender, EventArgs e)
        {
            if (!string.IsNullOrWhiteSpace(txtEmail.Text))
            {
                var authToken = _authenticationServiceClient.Login("username", "password").ResultData;

                if (!string.IsNullOrWhiteSpace(authToken))
                {
                    var newInvitation = _invitationManagementServiceClient.CreateInvitation(authToken, 1129, "Api Test Invitation").ResultData;
                    Logger($"Created new invitation with id {newInvitation.DatabaseId}");

                    newInvitation.Body =
                        "You have been invited to take the survey: Invitation API Test.<br /><br /><a href=\"@@SURVEY_URL_PLACEHOLDER__DO_NOT_ERASE\">Click here</a>&nbsp;to take the survey." + 
                                        "<br /><br />===================================<br /><a id=\"unsubscribeLink\" href=\"@@OPT_OUT_PLACEHOLDER__DO_NOT_ERASE\">Unsubscribe from this list</a>" + 
                                        "<br /><br />Our mailing address is:<br />@@FooterCompany<br />@@FooterAddress1<br />@@FooterAddress2<br />@@FooterCity, @@FooterState @@FooterPostCode<br />@@FooterCountry";
                    newInvitation.FromAddress = "support@checkbox.com";
                    newInvitation.FromName = "Checkbox Support";
                    newInvitation.IncludeOptOut = true;
                    newInvitation.ReminderBody = $"Reminder : {newInvitation.Body}";
                    newInvitation.Subject = $"Reminder : {newInvitation.Subject}";
                    
                    _invitationManagementServiceClient.UpdateInvitation(authToken, newInvitation);
                    Logger($"Updated invitation with id {newInvitation.DatabaseId}");

                    _invitationManagementServiceClient.AddEmailAddressesToInvitation(authToken, newInvitation.DatabaseId,
                        new[] {txtEmail.Text});
                    Logger($"Added {txtEmail.Text} as a recipient to invitation with id {newInvitation.DatabaseId}");

                    _invitationManagementServiceClient.AddScheduledInvitationActivity(authToken, newInvitation.DatabaseId, "Invitation",
                        DateTime.UtcNow.AddMinutes(2).ToString());
                    Logger($"Scheduled invitation to be sent out :  {DateTime.UtcNow.AddMinutes(2)}");

                    _invitationManagementServiceClient.AddScheduledInvitationActivity(authToken, newInvitation.DatabaseId, "Reminder",
                        DateTime.UtcNow.AddDays(7).ToString());
                    Logger($"Scheduled reminder to be sent out :  {DateTime.UtcNow.AddDays(7)}");

                    _invitationManagementServiceClient.Close();
                    _authenticationServiceClient.Close();

                }
            }
        }

        private void Logger(string logText)
        {
            txtLog.Text += $"{DateTime.UtcNow.ToString()} : {logText} {Environment.NewLine}";
        }
    }

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
Invitation ID int ID of the invitation that you would like to schedule
Schedule Activity Type string Type of activity to schedule. Valid parameters are “Invitation” and “Reminder”
Schedule Date string Date and Time to schedule the activity. This should be a date time in string format
This section is currently under construction. Any documents that appear blank will be populated as soon as possible. If you have any questions or need assistance with something that is not currently documented please feel free to submit a support ticket and we will be glad to assist you.
April 10, 2018

Web Services

  • Getting Started
    • Checking if API Is Live
    • Adding a service reference
  • Authentication
    • Login
  • Responses
    • Export Responses
  • Surveys
    • List Available Surveys
    • List Surveys and Folders
  • Users
    • Get User Data
    • Create User
    • Create User Group
    • Get Users
    • Lock User
    • Unlock User
  • Invitations
    • Create Invitation
    • Update Invitation
    • Add Scheduled Invitation Activity
    • Send Invitation to Filtered Recipient List
    • Create Email List Panel
    • Add Email Address To Email List Panel
    • Add Email List Panels to Invitation
  • Security
  • Styles

 

Checkbox develops affordable, feature-rich survey software for organizations, teams, and individuals. Available as a cloud-hosted subscription or installable software. API, source code and integration options available.

Checkbox Survey Inc.
65 Chapel Street, Newton, MA 02458  USA
General: 1-617-231-8890
Sales: 1-617-231-8891
Support: 1-617-231-8899
info@checkbox.com

  • Features
  • Pricing
  • On-Premises Software
  • Blog
  • Contact Us
  • Pay a Quote/Invoice
  • Support
  • Release Notes
  • API Documentation
  • Hosted SLA
  • Software License Agreement
  • Privacy Policy
©  2002 - Checkbox Survey, Inc.