Update Project API

This API is used to update a project. It may only be called when the project is NOT active, i.e. pre-launch or paused.

Command

"client/updateProject/1"


Apart from command and rfg_id, none of the parameters are mandatory. You should only include the parameters that you want to update. Country is the one field that cannot be changed after the project is submitted.


Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "client/updateProject/1"
rfg_id String

The RFG identifier of the project that you want to update.
name String

Internal name describing the survey.
title String

Text to be shown to the respondent describing the survey.
ir Integer

Incidence Rate of the project as a percent.
lengthOfInterview Integer

Average number of minutes it takes a user to complete your survey.
surveyURL String

Survey URL where we will send our panelists to take the survey. The link should contain a placeholder {sesskey} which we will replace with a unique session identifier to track respondents. For example:
http://the.link.to.the.survey/survey?sesskey={sesskey}
desiredCompletes Integer

Indicates the amount of completes that you want to accomplish on this project.
collectsPII Boolean

Indicates if the project asks for personal identifiable information.
notificationEmail String

The email address to receive notifications, if a project was paused due to conversion rules.
endOfFieldDate Date

Date survey is meant to end (yyyy-MM-dd or yyyy-MM-dd'T'HH:mm:ss'Z' format). Only used to evaluate project performance. Client must pause and close project when appropriate.
customerId String

Your internal ID for your customer.
customerManager String

The name of the manager of your internal customer.
contact Object

Primary contact for this project. The JSON should have the following keys:

{
     first: 'Tom',  
     last: 'Jones',  
     phone: '(123)456-7890',  
     email: 'tom@somewhere.com'  
}
duplicationKey String

Duplication key used by this project.

Different projects can be grouped using a duplicationKey. The duplicate check will be applied considering the whole group instead of a single project.
filterMode Integer

Indicates how the respondent will be considered as a duplicate in a group: based on starts or based on completes.

  1. Starts
  2. Completes
quotaLimitBy String

Indicates if the quota limits are set by completes or starts. The possible values are:

  • completes
  • starts
excludeNonMatching Boolean

Indicates if respondents not matching any quotas will be rejected.
surveyCategory Integer

See integer codes in appendix
phoneSupported Integer

Survey can be displayed on a phone. Defaults to Unknown.

  1. Unknown
  2. Yes
  3. No
tabletSupported Integer

Survey can be displayed on a tablet. Defaults to Unknown.

  1. Unknown
  2. Yes
  3. No

Outputs

The JSON output will always contain the original command and a result. If the result > 0, an error has occurred (refer to Error Codes) and a message field will describe the error. If result = 0, the command succeeded and there will not be response field.


Example Command

{  
     command: "client/updateProject/1",  
     rfg_id: "RFG12345-001",  
     name: "Some change in the name",  
     ir: 50  
}