External Screener Management
Replace external screener questions
Replace the project’s declared external screener question catalog. Works on draft and published projects. Pairs with externalScreenerLink: both are required to publish an external-screener project, and on a live project the flow starts for new applicants once both are set.
PUT
/
v1
/
projects
/
{projectId}
/
external-screener-questions
/
bulk
Replace external screener questions
curl --request PUT \
--url https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '
[
{
"questionId": "<string>",
"text": "<string>",
"options": [
"<string>"
]
}
]
'import requests
url = "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk"
payload = [
{
"questionId": "<string>",
"text": "<string>",
"options": ["<string>"]
}
]
headers = {
"x-api-key": "<x-api-key>",
"x-api-secret": "<x-api-secret>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<x-api-key>',
'x-api-secret': '<x-api-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify([{questionId: '<string>', text: '<string>', options: ['<string>']}])
};
fetch('https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'questionId' => '<string>',
'text' => '<string>',
'options' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk"
payload := strings.NewReader("[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-secret", "<x-api-secret>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk")
.header("x-api-key", "<x-api-key>")
.header("x-api-secret", "<x-api-secret>")
.header("Content-Type", "application/json")
.body("[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]"
response = http.request(request)
puts response.read_body[
{
"questionId": "<string>",
"questionType": "RADIO",
"text": "<string>",
"options": [
"<string>"
]
}
]Path Parameters
Body
application/json
Your stable identifier for the question; answer rows reference it.
Available options:
RADIO, CHECKBOX, TEXT, NUMBER, OTHER The question as shown to the participant.
Choice options for RADIO/CHECKBOX questions; answer rows reference these values.
Response
200 - application/json
Your stable identifier for the question; answer rows reference it.
Available options:
RADIO, CHECKBOX, TEXT, NUMBER, OTHER The question as shown to the participant.
Choice options for RADIO/CHECKBOX questions; answer rows reference these values.
Last modified on September 10, 2026
Was this page helpful?
⌘I
Replace external screener questions
curl --request PUT \
--url https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-api-secret: <x-api-secret>' \
--data '
[
{
"questionId": "<string>",
"text": "<string>",
"options": [
"<string>"
]
}
]
'import requests
url = "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk"
payload = [
{
"questionId": "<string>",
"text": "<string>",
"options": ["<string>"]
}
]
headers = {
"x-api-key": "<x-api-key>",
"x-api-secret": "<x-api-secret>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<x-api-key>',
'x-api-secret': '<x-api-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify([{questionId: '<string>', text: '<string>', options: ['<string>']}])
};
fetch('https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
[
'questionId' => '<string>',
'text' => '<string>',
'options' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>",
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk"
payload := strings.NewReader("[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-secret", "<x-api-secret>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk")
.header("x-api-key", "<x-api-key>")
.header("x-api-secret", "<x-api-secret>")
.header("Content-Type", "application/json")
.body("[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.respondent.io/v1/projects/{projectId}/external-screener-questions/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"questionId\": \"<string>\",\n \"text\": \"<string>\",\n \"options\": [\n \"<string>\"\n ]\n }\n]"
response = http.request(request)
puts response.read_body[
{
"questionId": "<string>",
"questionType": "RADIO",
"text": "<string>",
"options": [
"<string>"
]
}
]