Checkbox Survey Software Checkbox Survey Software
  • Survey Features
  • Pricing
  • On-Premises Version
  • Clients
  • Support
  • Sign In
  • Try it Free
Questions?(866) 430-8274 | (617) 231-8891|info@checkbox.com

Update Invitation

The UpdateInvitation method can be utilized to update an already created invitation. The method requires that you have already retrieved an InvitationData object from the GetInvitation method documented above.

You need to ensure that the message body contains the auto tracking link for your invitation and survey. You can add this in by adding @@SURVEY_URL_PLACEHOLDER__DO_NOT_ERASE into the body variable of your InvitationData that you send back to Checkbox.

If you are using Checkbox Online, you must also add in the appropriate opt out code ( @@OPT_OUT_PLACEHOLDER__DO_NOT_ERASE ) and company footer information, which can also be added into the InvitationData.Body variable.

class Test
{

    private static void Main()
    {
        dynamic client = new InvitationManagementServiceClient();

        //first you need to get the invitation data
        dynamic invitation = client.GetInvitation(authToken, 1318);
        if (!invitation.CallSuccess) {
            Console.WriteLine(invitation.FailureMessage);
            //Invitation was not retrieved, exit the code
            return;
        }

        dynamic invitationData = invitation.ResultData;

        //once you have invitation data you can work on your updates
        invitationData.Body = "This is my invitation body";
        invitationData.Subject = "This is the subject of my invitation";
        invitationData.FromAddress = "admin@checkbox.com";
        invitationData.FromName = "Checkbox Admin";

        //once you are done making your updates, you can send the invitation back to Checkbox to apply your changes
        dynamic updateResult = client.UpdateInvitation(authToken, invitationData);

        if (!updateResult.CallSuccess) {
            Console.WriteLine(invitation.FailureMessage);
            return;
        }

        //Always close the client
        client.Close();

    }
}

 

 

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
invitation invitationData InvitationData that you want to update in Checkbox
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.
May 15, 2017

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.
44 Pleasant Street, Watertown, MA  02472  USA
(617) 231-8890
info@checkbox.com

  • Features
  • Pricing
  • On-Premises Software
  • Blog
  • Contact Us
  • Pay a Quote/Invoice
  • Support
  • Release Notes
  • Developer Center
  • Hosted SLA
  • Software License Agreement
  • Privacy Policy
©  Checkbox Survey, . Screen images on this site have been simulated for clarity of display.
LinkedinFacebookTwitter