Updates the project specified by the ProjectGuid parameter.

Endpoint URL

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

Parameters

ProjectGuid
globally unique identifier		 ClearVoice's unique identifier for a project.

Required
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.
PartnerProjectId
string		 Unique identifier for an external survey this project is related too.

String length: inclusive between 0 and 50
PartnerSalesperson
string		 Salesperson ClearVoice should communicate with in regards to this project.
ProjectTriggers
Triggers		 Triggers to close the project when hit.
ProjectPixelUrls
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.
SurveyInvitations
Collection of ProjectSurveyInvitation 		Currently the two languages supported are en-us or fr-ca.
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.

Example Request Data

{
  "ProjectGuid": "00ceb1a0-dd1d-4a41-830d-6f4036ade535",
  "SurveyUrl": "sample string 2",
  "SurveyLength": 1,
  "PartnerProjectId": "sample string 3",
  "PartnerSalesperson": "sample string 4",
  "ProjectTriggers": {
    "StartCap": 1,
    "CompleteCap": 1,
    "OverQuotaCap": 1,
    "TerminateCap": 1
  },
  "ProjectPixelUrls": [
    "sample string 1",
    "sample string 2"
  ],
  "AllowSurveyRestart": true,
  "SpeedDetection": {
    "IsEnabled": true,
    "MinLength": 1,
    "MaxLength": 1
  },
  "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": "cbd9d8ab-d02c-4f7d-a10e-9f1d8c29568c",
      "Answers": [
        {
          "AnswerGuid": "73314f58-fc3a-42e5-8bf6-e4d3f25b1073"
        },
        {
          "AnswerGuid": "73314f58-fc3a-42e5-8bf6-e4d3f25b1073"
        }
      ]
    },
    {
      "DemographicGuid": "cbd9d8ab-d02c-4f7d-a10e-9f1d8c29568c",
      "Answers": [
        {
          "AnswerGuid": "73314f58-fc3a-42e5-8bf6-e4d3f25b1073"
        },
        {
          "AnswerGuid": "73314f58-fc3a-42e5-8bf6-e4d3f25b1073"
        }
      ]
    }
  ]
}

Response Description

ProjectGuid
globally unique identifier		 ClearVoice unique

Example Response

{
  "ProjectGuid": "05c3e7d3-5dbd-4f5e-a237-87b85206fd56"
}