Update a project
Update one or more fields on an existing project. Only the fields you include in the request body are modified — omitted fields are left unchanged. The set of editable fields depends on the project’s status: draft B2B, draft B2C, and published projects each accept different request bodies. Once a project is live (projectStatus: PAID), only publicTitle, publicInternalName, publicDescription, participantTimeRequiredMinutes, incentiveAmount, ndaDetails, externalResearcher, externalScreenerLink, and unmoderatedStudyOrSurvey.deadline can be changed — targeting and recruitment fields such as targetNumberOfParticipants are locked. See Editing a project after publish in Project statuses for the full list.
Completion deadlines
For Unmoderated Study and Survey projects,unmoderatedStudyOrSurvey.deadline (endsAt, optional IANA timezone) can be changed on both draft and published projects. Only the fields you send are changed — omitting timezone keeps the stored one. On a published project, the new deadline also applies to participants with an open invitation (not to those who have already completed the task or whose invitation was cancelled).
External screener link
For external-screener organizations,externalScreenerLink can be set or changed on both draft and published projects. It is required while externalQuestions are declared, so on a published project a null is rejected with a 400 in that case; otherwise null removes it. Participants already handed off to your screener keep the URL they were sent to; new applicants get the new one. See External screeners.
Changing the audience
On a draft,targetMarketType can be switched between b2b and b2c. The project’s quota is left as it is, so a quota condition on a B2B-only attribute blocks publish once the draft is b2c. See Audience quotas.Body
- Update Draft B2C Project
- Update Draft B2B Project
- Update Published Project
Kind of research to be conducted for this project. Details here.
If typeOfResearch == inPerson → allowed values are: [oneOnOne, focusGroup, inRespondentHome, inRespondentOffice]
If typeOfResearch == remote → allowed values are: [oneOnOne, focusGroup, unmoderatedStudy, survey, diaryStudy]
oneOnOne, focusGroup, inRespondentHome, inRespondentOffice, unmoderatedStudy, survey, diaryStudy Dollars ranging: Min 5 and Max 1000. Pro tip: Set your incentive at or above $2 per minute (B2C) or $3 per minute (B2B) to attract quality participants faster. More tips to pick the right incentive: https://help.respondent.io/en/articles/5471087-what-is-the-best-incentive-for-my-research-project
Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all External-screener organizations only. The URL of your own screener:
participants who qualify on the Respondent screener are sent here to
complete yours, with respondent_* correlation parameters appended
(respondent_user_id, respondent_profile_id,
respondent_screener_response_id, respondent_project_id). Post their
answers back with the External Screener Answers endpoint before
redirecting them to the apply page they came from — never to the
project's completionUrl. Pairs with externalQuestions: a project may
hold just the link while it is a draft (declare the catalog later through
the external-screener-questions bulk endpoint), but publishing requires
the two together. Can also be set or changed on a published project via
Update a project (but not cleared while externalQuestions are
declared) — participants already handed off keep the URL they were sent
to; new applicants get the new one. Must be an absolute https:// URL:
participants are redirected to it with their correlation ids in the
query string, and a bare hostname cannot be turned into a link.
External-screener organizations only. The declared catalog of your
screener's questions: answer rows are validated against these
questionIds, and the application reads as submitted once every declared
question has an answer (or an answers payload says complete: true).
Also settable via the external-screener-questions bulk endpoint. Pairs
with externalScreenerLink: publishing requires the two together.
Regions to recruit from within targetCountries, as ISO 3166-2 codes
(e.g. US-CA). Each region narrows only its own country: a targeted
country with no regions is recruited from in full. Only US states are
supported today. Remote projects only. With targetCities too, a
participant near a city or in a region qualifies. Send an empty array
to clear.
Regions to recruit from within targetCountries, as ISO 3166-2 codes
(e.g. US-CA). Each region narrows only its own country: a targeted
country with no regions is recruited from in full. Only US states are
supported today. Remote projects only. With targetCities too, a
participant near a city or in a region qualifies. Send an empty array
to clear.
US-AL, US-AK, US-AZ, US-AR, US-CA, US-CO, US-CT, US-DE, US-DC, US-FL, US-GA, US-HI, US-ID, US-IL, US-IN, US-IA, US-KS, US-KY, US-LA, US-ME, US-MD, US-MA, US-MI, US-MN, US-MS, US-MO, US-MT, US-NE, US-NV, US-NH, US-NJ, US-NM, US-NY, US-NC, US-ND, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VT, US-VA, US-WA, US-WV, US-WI, US-WY You can select audience signals to restrict who qualifies for this project. Learn more about filters vs signals. Learn more about filters vs signals: https://help.respondent.io/en/articles/5482285-filtering-targeting-and-qualifying
You can select audience signals to restrict who qualifies for this project. Learn more about filters vs signals. Learn more about filters vs signals: https://help.respondent.io/en/articles/5482285-filtering-targeting-and-qualifying
targetProjectTopics, relationshipStatus, languages, numberOfChildren, numberOfChildrenLiveAtHome, childrenBirthYears, livingSituation, pets, homeOwner, nationality, militaryServiceStatus, employmentStatuses, cloudPlatforms, codingAITools, designPrototypingTools, productivitySoftware, streamingServices, foodDeliveryServices, onlineBankingTools, onlineLearningPlatforms, onlineMarketplacePlatforms, onlineTravelBooking, smartHomeDevices, socialNetworkPlatforms, vehicleBrands, healthWellnessApps, onlineShoppingFrequency Flat advanced-targeting attribute map (relationship status, languages,
devices, products & services and shopping preferences, …). All advanced
attributes are available to B2C and B2B alike. Each provided attribute acts
as a soft preference unless promoted to a hard filter via keyQualifiers,
EXCEPT for the always-hard attributes that act as hard filters whenever set
and cannot be soft-moded (they are absent from the KeyQualifier enum):
areaType, workSetting, browsers, computerOS, programmingLanguages,
tabletOS, smartphoneOS, webcam, mobilePhoneWithInternet,
headsetWithMicrophone.
On update, advancedTargeting is merged per attribute: include a key to set
it, send null to clear it, omit a key to leave it unchanged. For array
attributes an empty array [] also clears the targeting (treated as no
target). keyQualifiers is replaced as a whole.
Beta: behind the advanced-targeting-attributes org feature flag.
- If researcher wants to filter out participants who have participated in past projects.
- Past Participation logic is used at Researcher level based on external reseacher id.
- The participant must have been paid for a project to count as a past participant.
- Past participation filtering is available within 4 hours of a payout being made, NOT immediately after payment.
ndaType = file is not supported on this endpoint. Use the Upload NDA File endpoint to upload NDA documents
Pass ids only. IDs differ from staging to production. General Population (B2C) projects only. Tagging your projects with topics will better help match your general population project with participants that have indicated interest in these topics. Required (Min 1) unless your organization is enabled for optional topics, in which case it may be omitted or empty. Array: Max 2.
2Response
Kind of research to be conducted for this project. Details here.
If typeOfResearch == inPerson → allowed values are: [oneOnOne, focusGroup, inRespondentHome, inRespondentOffice]
If typeOfResearch == remote → allowed values are: [oneOnOne, focusGroup, unmoderatedStudy, survey, diaryStudy]
oneOnOne, focusGroup, inRespondentHome, inRespondentOffice, unmoderatedStudy, survey, diaryStudy Dollars ranging: Min 5 and Max 1000. Pro tip: Set your incentive at or above $2 per minute (B2C) or $3 per minute (B2B) to attract quality participants faster. More tips to pick the right incentive: https://help.respondent.io/en/articles/5471087-what-is-the-best-incentive-for-my-research-project
External-screener organizations only. The URL of your own screener:
participants who qualify on the Respondent screener are sent here to
complete yours, with respondent_* correlation parameters appended
(respondent_user_id, respondent_profile_id,
respondent_screener_response_id, respondent_project_id). Post their
answers back with the External Screener Answers endpoint before
redirecting them to the apply page they came from — never to the
project's completionUrl. Pairs with externalQuestions: a project may
hold just the link while it is a draft (declare the catalog later through
the external-screener-questions bulk endpoint), but publishing requires
the two together. Can also be set or changed on a published project via
Update a project (but not cleared while externalQuestions are
declared) — participants already handed off keep the URL they were sent
to; new applicants get the new one. Must be an absolute https:// URL:
participants are redirected to it with their correlation ids in the
query string, and a bare hostname cannot be turned into a link.
External-screener organizations only. The declared catalog of your
screener's questions: answer rows are validated against these
questionIds, and the application reads as submitted once every declared
question has an answer (or an answers payload says complete: true).
Also settable via the external-screener-questions bulk endpoint. Pairs
with externalScreenerLink: publishing requires the two together.
Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Use targetCountries instead.
AX, AL, DZ, AS, AD, AI, AQ, AG, AR, AM, AW, AU, AT, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, VG, IO, BN, BG, BF, BI, CV, CM, CA, KY, CF, TD, CL, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, CD, DK, DJ, DM, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, LA, LV, LB, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, NA, NR, NP, NL, NC, NZ, NI, NE, NU, NF, KP, MK, MP, NO, OM, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RW, RE, SH, KN, LC, PM, VC, WS, SM, ST, SA, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SR, SJ, SE, CH, TZ, TW, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, AE, GB, UM, US, UY, VU, VE, VN, WF, EH, ZM, ZW, all Regions to recruit from within targetCountries, as ISO 3166-2 codes
(e.g. US-CA). Each region narrows only its own country: a targeted
country with no regions is recruited from in full. Only US states are
supported today. Remote projects only. With targetCities too, a
participant near a city or in a region qualifies. Send an empty array
to clear.
Regions to recruit from within targetCountries, as ISO 3166-2 codes
(e.g. US-CA). Each region narrows only its own country: a targeted
country with no regions is recruited from in full. Only US states are
supported today. Remote projects only. With targetCities too, a
participant near a city or in a region qualifies. Send an empty array
to clear.
US-AL, US-AK, US-AZ, US-AR, US-CA, US-CO, US-CT, US-DE, US-DC, US-FL, US-GA, US-HI, US-ID, US-IL, US-IN, US-IA, US-KS, US-KY, US-LA, US-ME, US-MD, US-MA, US-MI, US-MN, US-MS, US-MO, US-MT, US-NE, US-NV, US-NH, US-NJ, US-NM, US-NY, US-NC, US-ND, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VT, US-VA, US-WA, US-WV, US-WI, US-WY Available for Industry professionals (B2B) projects
accountingAuditing, administrative, advertising, analyst, artCreative, businessDevelopment, consulting, customerService, distribution, design, education, finance, generalBusiness, healthcareProvider, humanResources, informationTechnology, legal, management, manufacturing, marketing, other, publicRelations, purchasing, productManagement, projectManagement, production, qualityAssurance, research, sales, science, strategyPlanning, supplyChain, training, writingEditing - If researcher wants to filter out participants who have participated in past projects.
- Past Participation logic is used at Researcher level based on external reseacher id.
- The participant must have been paid for a project to count as a past participant.
- Past participation filtering is available within 4 hours of a payout being made, NOT immediately after payment.
- Autopay is used to automatically pay participants after they complete a project.
- If not provided, defaults to
true.
- If not provided, defaults to
- Autoinvite is used to automatically invite participants to a project if they qualify after completing the screener.
- Only available when
targetResearchMethodologyis one of: [unmoderatedStudy,survey]. - If not provided, defaults to
false.
- Only available when
Converts signals into required match filters. Details here.
Converts signals into required match filters. Details here.
targetHouseholdIncome, targetProfessionalIndustries, targetCompanySize, targetProjectTopics, targetAudienceSkills, relationshipStatus, languages, numberOfChildren, numberOfChildrenLiveAtHome, childrenBirthYears, livingSituation, pets, homeOwner, nationality, militaryServiceStatus, employmentStatuses, cloudPlatforms, codingAITools, designPrototypingTools, productivitySoftware, streamingServices, foodDeliveryServices, onlineBankingTools, onlineLearningPlatforms, onlineMarketplacePlatforms, onlineTravelBooking, smartHomeDevices, socialNetworkPlatforms, vehicleBrands, healthWellnessApps, onlineShoppingFrequency Flat advanced-targeting attribute map set on this project (relationship
status, languages, devices, products & services, professional and shopping
preferences, …). Present only when the requesting organisation has the
advanced-targeting-attributes feature flag enabled. All advanced
attributes appear identically on B2C and B2B projects.