Homepage / Doc / Create Invitation

Create Invitation

The CreateInvitation method can be utilized to create an invitation within Checkbox. This invitation is created with default settings for all fields, and with an empty subject and email body. Since the body of the email is blank, it does not contain an auto tracking link for your invitation and survey. You can add this in by adding @@SURVEY_URL_PLACEHOLDER__DO_NOT_ERASE into the body in the UpdateInvitation method.

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.

This method will return the invitation object that was created back to you.

class Test
{
    static void Main()
    {
      var client = new InvitationManagementServiceClient();

      var invitation = client.CreateInvitation(authToken, 1404, "My API Invitation");

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

      Console.WriteLine("New invitation was created with ID of {0}", invitation.ResultData.DatabaseId);

      client.Close();
    }
}

 

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
ResponseTemplateId int ID of the survey that you want to create the invitation for
Name string Name of the invitation
May 15, 2017