Creates a project specified by the request parameter.

Endpoint URL

http://api.clearvoicesurveys.com/api/v1/projects/createproject

Parameters

ProjectName
string		 The name to refer to this project

Required

Max length: 100
SurveyUrl
string		 Url to the survey this project is for.

String length: inclusive between 0 and 500
SurveyLength
integer		 Estimated length of time to complete the survey (in minutes).

Required
PartnerProjectId
string		 Unique identifier for an external survey this project is related to.

String length: inclusive between 0 and 50
PartnerSalesperson
string		 Salesperson ClearVoice should communicate with in regards to this project.

String length: inclusive between 0 and 200
RequestedCpi
decimal number		 Requested Cost Per Invite The Requested CPI will be added to the Project Notes for the Project Manager to review.
ProjectTriggers
Triggers		 Trigger action on project when activity count reached.
ProjectPixels
Collection of string 		List of valid Urls that are the project level pixels which will be fired after the member completes the survey and is redirected back to ClearVoice for processing. ClearVoice currently only supports 5 pixels per project.
AllowSurveyRestart
boolean		 Used to determine whether or not a member can restart a survey.
SpeedDetection
SpeedDetection		 Fraud mechanism used to determine if a member is completing a survey too quickly or slowly.
Notes
string		 Any miscellaneous notes you would like to store on the project

String length: inclusive between 0 and 5000
SurveyInvitations
Collection of ProjectSurveyInvitation 		Survey Invitation localized resources
ExclusionCriteria
Collection of DemographicCriteria 		Demographics and Answers that will serve as criteria to exclude members from the project. No partial updates are supported for ExclusionCriteria. Only full updates are supported.

Example Request Data

{
  "ProjectName": "sample string 1",
  "SurveyUrl": "sample string 2",
  "SurveyLength": 3,
  "PartnerProjectId": "sample string 4",
  "PartnerSalesperson": "sample string 5",
  "RequestedCpi": 1.0,
  "ProjectTriggers": {
    "StartCap": 1,
    "CompleteCap": 1,
    "OverQuotaCap": 1,
    "TerminateCap": 1
  },
  "ProjectPixels": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowSurveyRestart": true,
  "SpeedDetection": {
    "IsEnabled": true,
    "MinLength": 1,
    "MaxLength": 1
  },
  "Notes": "sample string 7",
  "SurveyInvitations": [
    {
      "SurveyName": "sample string 1",
      "Culture": "sample string 2",
      "EmailInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      },
      "EmailReInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      }
    },
    {
      "SurveyName": "sample string 1",
      "Culture": "sample string 2",
      "EmailInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      },
      "EmailReInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      }
    }
  ],
  "ExclusionCriteria": [
    {
      "DemographicGuid": "84c722fa-5ca3-4f89-baff-b4508491cef7",
      "Answers": [
        {
          "AnswerGuid": "957c53aa-42aa-42aa-a81e-1e968baf15d4"
        },
        {
          "AnswerGuid": "957c53aa-42aa-42aa-a81e-1e968baf15d4"
        }
      ]
    },
    {
      "DemographicGuid": "84c722fa-5ca3-4f89-baff-b4508491cef7",
      "Answers": [
        {
          "AnswerGuid": "957c53aa-42aa-42aa-a81e-1e968baf15d4"
        },
        {
          "AnswerGuid": "957c53aa-42aa-42aa-a81e-1e968baf15d4"
        }
      ]
    }
  ]
}

Response Description

ProjectGuid
globally unique identifier		 ClearVoice's unique identifier for the project the quota group should be created in.
PartnerProjectId
string		 Unique identifier for an external survey this project is related to.
SuccessUrl
string		 Url that the survey proctor routes a member too after a successful complete
TermUrl
string		 Url that the survey proctor routes a member too after a member terms.
OverQuotaUrl
string		 Url that the survey proctor routes a member too after a member is determined to be over quota.
RejectUrl
string
DuplicateUrl
string

Example Response

{
  "ProjectGuid": "d1e69539-c2e0-4a5e-a034-233d9d8dcf42",
  "PartnerProjectId": "sample string 2",
  "SuccessUrl": "sample string 3",
  "TermUrl": "sample string 4",
  "OverQuotaUrl": "sample string 5",
  "RejectUrl": "sample string 6",
  "DuplicateUrl": "sample string 7"
}