Update a study
curl --request PUT \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": {
"interviewDurationMinutes": 60
}
}
}
'import requests
url = "https://api.rallyuxr.com/api/public/v1/studies/{studyId}"
payload = { "studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": True,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": { "interviewDurationMinutes": 60 }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
studyPlan: {
name: '<string>',
externalName: '<string>',
description: '<string>',
externalDescription: '<string>',
startDate: '2025-01-01',
endDate: '2025-01-02',
researchPlanUrl: '<string>',
participationLimit: 10,
consentFormId: '<string>',
incentive: {
incentiveBudgetId: '<string>',
amount: 123,
customIncentiveId: '<string>',
defaultCustomIncentiveValue: '<string>'
},
includeScreener: true,
brandingConfigId: '<string>',
language: 'en',
scheduler: {interviewDurationMinutes: 60}
}
})
};
fetch('https://api.rallyuxr.com/api/public/v1/studies/{studyId}', 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.rallyuxr.com/api/public/v1/studies/{studyId}",
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([
'studyPlan' => [
'name' => '<string>',
'externalName' => '<string>',
'description' => '<string>',
'externalDescription' => '<string>',
'startDate' => '2025-01-01',
'endDate' => '2025-01-02',
'researchPlanUrl' => '<string>',
'participationLimit' => 10,
'consentFormId' => '<string>',
'incentive' => [
'incentiveBudgetId' => '<string>',
'amount' => 123,
'customIncentiveId' => '<string>',
'defaultCustomIncentiveValue' => '<string>'
],
'includeScreener' => true,
'brandingConfigId' => '<string>',
'language' => 'en',
'scheduler' => [
'interviewDurationMinutes' => 60
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.rallyuxr.com/api/public/v1/studies/{studyId}"
payload := strings.NewReader("{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.rallyuxr.com/api/public/v1/studies/{studyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rallyuxr.com/api/public/v1/studies/{studyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>",
"currency": "USD"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": {
"interviewDurationMinutes": 60
}
},
"createdAt": "2023-11-07T05:31:56Z",
"createdFromTemplateId": "<string>",
"owners": [
{
"userId": "<string>",
"emailAccountId": "<string>",
"fullname": "<string>",
"email": "<string>"
}
],
"screener": {
"id": "<string>",
"workspaceId": "<string>",
"studyId": "<string>",
"type": "RALLY",
"showSchedulerToQualified": true,
"qualifyByDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"questions": [
{
"category": "simple",
"type": "SHORT_FORM",
"name": "<string>",
"isRequired": true,
"id": "<string>",
"workspaceId": "<string>",
"description": "<string>",
"mappedToPropertyId": "<string>",
"questionTemplateId": "<string>"
}
],
"externalSurveyId": "<string>",
"surveyMonkeyCollectorId": "<string>",
"externalSurveySetupStatus": "IN_PROGRESS",
"externalSurveySetupErrorCode": "<string>",
"externalSurveySetupUpdatedAt": "2023-11-07T05:31:56Z",
"customLinkUrl": "<string>",
"customLinkTokensJson": "<string>"
}
}{
"errors": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}UnauthorizedForbidden{Resource} not foundToo Many RequestsInternal Server ErrorStudies
Update a study
Update a study in your workspace. All data returned from a GET on a study needs to be included or will be overwritten. Certain features not supported and require updating in the UI
PUT
/
studies
/
{studyId}
Update a study
curl --request PUT \
--url https://api.rallyuxr.com/api/public/v1/studies/{studyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": {
"interviewDurationMinutes": 60
}
}
}
'import requests
url = "https://api.rallyuxr.com/api/public/v1/studies/{studyId}"
payload = { "studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>"
},
"includeScreener": True,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": { "interviewDurationMinutes": 60 }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
studyPlan: {
name: '<string>',
externalName: '<string>',
description: '<string>',
externalDescription: '<string>',
startDate: '2025-01-01',
endDate: '2025-01-02',
researchPlanUrl: '<string>',
participationLimit: 10,
consentFormId: '<string>',
incentive: {
incentiveBudgetId: '<string>',
amount: 123,
customIncentiveId: '<string>',
defaultCustomIncentiveValue: '<string>'
},
includeScreener: true,
brandingConfigId: '<string>',
language: 'en',
scheduler: {interviewDurationMinutes: 60}
}
})
};
fetch('https://api.rallyuxr.com/api/public/v1/studies/{studyId}', 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.rallyuxr.com/api/public/v1/studies/{studyId}",
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([
'studyPlan' => [
'name' => '<string>',
'externalName' => '<string>',
'description' => '<string>',
'externalDescription' => '<string>',
'startDate' => '2025-01-01',
'endDate' => '2025-01-02',
'researchPlanUrl' => '<string>',
'participationLimit' => 10,
'consentFormId' => '<string>',
'incentive' => [
'incentiveBudgetId' => '<string>',
'amount' => 123,
'customIncentiveId' => '<string>',
'defaultCustomIncentiveValue' => '<string>'
],
'includeScreener' => true,
'brandingConfigId' => '<string>',
'language' => 'en',
'scheduler' => [
'interviewDurationMinutes' => 60
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.rallyuxr.com/api/public/v1/studies/{studyId}"
payload := strings.NewReader("{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.rallyuxr.com/api/public/v1/studies/{studyId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rallyuxr.com/api/public/v1/studies/{studyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"studyPlan\": {\n \"name\": \"<string>\",\n \"externalName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalDescription\": \"<string>\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-01-02\",\n \"researchPlanUrl\": \"<string>\",\n \"participationLimit\": 10,\n \"consentFormId\": \"<string>\",\n \"incentive\": {\n \"incentiveBudgetId\": \"<string>\",\n \"amount\": 123,\n \"customIncentiveId\": \"<string>\",\n \"defaultCustomIncentiveValue\": \"<string>\"\n },\n \"includeScreener\": true,\n \"brandingConfigId\": \"<string>\",\n \"language\": \"en\",\n \"scheduler\": {\n \"interviewDurationMinutes\": 60\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"studyId": "<string>",
"studyType": "SURVEY",
"recruitmentStrategy": "IN_RALLY",
"status": "DRAFT",
"studyPlan": {
"name": "<string>",
"externalName": "<string>",
"description": "<string>",
"externalDescription": "<string>",
"startDate": "2025-01-01",
"endDate": "2025-01-02",
"researchPlanUrl": "<string>",
"participationLimit": 10,
"consentFormId": "<string>",
"incentive": {
"incentiveType": "MONEY_OR_GIFT_CARD",
"incentiveBudgetId": "<string>",
"amount": 123,
"customIncentiveId": "<string>",
"defaultCustomIncentiveValue": "<string>",
"currency": "USD"
},
"includeScreener": true,
"brandingConfigId": "<string>",
"language": "en",
"scheduler": {
"interviewDurationMinutes": 60
}
},
"createdAt": "2023-11-07T05:31:56Z",
"createdFromTemplateId": "<string>",
"owners": [
{
"userId": "<string>",
"emailAccountId": "<string>",
"fullname": "<string>",
"email": "<string>"
}
],
"screener": {
"id": "<string>",
"workspaceId": "<string>",
"studyId": "<string>",
"type": "RALLY",
"showSchedulerToQualified": true,
"qualifyByDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"questions": [
{
"category": "simple",
"type": "SHORT_FORM",
"name": "<string>",
"isRequired": true,
"id": "<string>",
"workspaceId": "<string>",
"description": "<string>",
"mappedToPropertyId": "<string>",
"questionTemplateId": "<string>"
}
],
"externalSurveyId": "<string>",
"surveyMonkeyCollectorId": "<string>",
"externalSurveySetupStatus": "IN_PROGRESS",
"externalSurveySetupErrorCode": "<string>",
"externalSurveySetupUpdatedAt": "2023-11-07T05:31:56Z",
"customLinkUrl": "<string>",
"customLinkTokensJson": "<string>"
}
}{
"errors": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}UnauthorizedForbidden{Resource} not foundToo Many RequestsInternal Server ErrorAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Study plan object
Show child attributes
Show child attributes
Response
The updated study
Study object including its screener
The type of study
Available options:
SURVEY, INTERVIEWS, UNMODERATED_TEST, GROUP_INTERVIEW The recruitment strategy for the study
Available options:
IN_RALLY, EXTERNAL The status of the study
Available options:
DRAFT, ACTIVE, PAUSED, CLOSED Study plan object
Show child attributes
Show child attributes
The ID of the template this study was created from, or null if not created from a template
Show child attributes
Show child attributes
The study's screener with all of its questions. Null when the study has no screener or the caller cannot read screeners. Not included in list responses.
Show child attributes
Show child attributes