Respondent Exclusion / Recontact

In order to exclude or recontact specific respondents from a survey, you need to supply PureSpectrum with a list of persistend Respondent ID's (PSID's).

There are 2 steps to creating an exclude / recontact survey:

Step 1

Include the parameter incl_excl in the POST /surveys call (Create survey endpoint reference).

The possible values for incl_excl are:

0 - for an exclude survey: the PSID's present in the survey's PSIDref list will not be allowed to participate.

1 - for a recontact survey: the PSID's present in the survey's PSIDref list will be the only respondents allowed to participate.

Step 2

Create a PSIDref list using the POST /surveys/:SURVEY_ID/PSIDref call (Add a PSIDref list to a survey endpoint reference).

Considerations

You may not launch a survey where "incl_excl": 1 if there are no values in the PSIDref list.

You may not change the value of incl_excl once you have created the draft.

Create a recontact survey with Unique Entry Links for each respondent

In order to specify unique links for each respondent in a recontact survey, the same steps are to be applied, with extra attributes applied to the endpoint calls.

Step 1

Specify that the survey is a recontact survey by setting the parameter incl_excl=1 and uniqueLinks=true in the Create survey endpoint.

Step 2

Specify the list of respondents allowed to take the survey, by creating a PSIDref list using the Add a PSIDref list to a survey endpoint, by passing the PSID's and links for each respondent.

Example:

[
  { "psid": "75xxee23-370b-a8ye-e601-e1fzz59284c8","link":"https://mysurvey.com/1" },
  { "psid": "94xx7b3b-4608-01y4-b908-8aezzab971e1","link":"https://mysurvey.com/2" },
  { "psid": "24xx7db6-8507-47y9-9c67-0c6zz6244d98","link":"https://mysurvey.com/3" },
  { "psid": "599446a6-6388-4ffe-4c37-9bdc9f6e6edc","link":"https://mysurvey.com/4" },
  { "psid": "685330d0-a8f2-df6f-ae28-7eb89d290277","link":"https://mysurvey.com/5" }
]

Considerations

You may not launch a survey where "incl_excl": 1 if there are no values in the PSIDref list.

You may not change the value of incl_excl after you have created the draft.

You may not change the value of uniqueLinks after you have created the draft.

For more information on the exclusion / inclusion, access the Advanced Filters - Exclusion & Feasibility page.

Respondent Exclusion / Recontact

Create a recontact survey with Unique Entry Links for each respondent#

Create a recontact survey with Unique Entry Links for each respondent