Context:
This API helps you to customize the Respondent Status list and exclude any samples that match that status in a Survey Grouping.
Note:
In order to send statuses in the payload, please make sure that the Respondent Status Filter config is enabled
Case 1 - When the valid respondent statuses are sent while creating a survey
Request
Request URL:
POST <BASE_URL>/buyers/v2/surveys headers - access-token: <BUYER_ACCESS_TOKEN>
Request Body:
{ "survey_title": "Survey Test - exclusions", "click_balancing": 0, "survey_category_code": 232, "survey_localization": "en_US", "completes_required": 100, "expected_ir": 50, "expected_loi": 5, "field_time": 20, "qualifications": [], "live_url": "https://my.survey.com?survey_id=1234", "test_url": "https://my.survey.com?survey_id=1234&test=1", "feasibility_exclusions": { "enable": false, "start": "20250501", "end": "20250630", "criterias": [], "criteriaSurveys": [ 18887 ], "statuses": [12, 16, 20, 21, 29] } }
"feasibility_exclusions": {
"enable": false,
"start": "20250501",
"end": "20250630",
"criterias": [],
"criteriaSurveys": [
18887
],
"statuses": [12, 16, 20, 21, 29]
}
}
Response
Response Code:
CODE: 200 OK
Response Body:
{ "qbp": { "enable": false }, "qlc": { "enable": false, "multiple_quotas": { "enable": false, "count_by_quota": false, "compensate_by_quota": false } }, "soft_launch": { "enable": false }, "unique_links": { "enable": false }, "click_balancing": 0, "estimated_clicks": 0, "survey_external_id": "", "ps_survey_status": 11, "offer_price": null, "incl_excl": 0, "quota_throttling": false, "url_transform": false, "subscriber_emails": [], "survey_title": "Survey Test - exclusions", "survey_category_code": 232, "completes_required": 100, "field_time": 20, "buyer_message": null, "is_modular_survey": false, "live_url": "https://my.survey.com?survey_id=1234", "billing_id": null, "test_url": "https://my.survey.com?survey_id=1234&test=1", "expected_loi": 5, "expected_ir": 50, "ps_survey_id": 19169, "buyer_surveygroup_ref": null, "buyer_surveygroup_refs": [], "test_ps_survey_entry_link": "http://localhost:3000/#/start-survey?survey_id=19169&ps_redirect_test=1&bsec=a70mx8&supplier_id=23", "survey_localization": "en_US", "uniqueLinks": false, "quotas": [], "qualifications": [], "is_feot_enabled": false, "feot": {}, "survey_grouping": [], "blend_id": null, "schedule_launch": { "enable": false, "info": { "date": null, "hours": null, "minutes": null, "timezone": null, "dateTimeInISO": null } }, "price_reco": false, "project_creation_date": "2025-07-07T12:30:21.569Z", "project_last_complete_date": null, "is_dq_enable": false, "mc_count": 0, "tc_count": 0, "basic_token": { "enable": false, "value": null }, "is_pure_price_rate_card_enable": true, "dq_settings": { "purescore_filter_enabled": true, "fp_device_check": true, "fp_fraud_check": true }, "product": "", "pds_ignore_override": false, "supplier_allocation_throttle": false, "blend_applied": false, "default_pure_price_override": false }
Case 2 - When the empty array of respondent statuses are sent while creating a survey
Request
Request URL:
POST <BASE_URL>/buyers/v2/surveys headers - access-token: <BUYER_ACCESS_TOKEN>
Request Body:
{ "survey_title": "Survey Test - exclusions", "click_balancing": 0, "survey_category_code": 232, "survey_localization": "en_US", "completes_required": 100, "expected_ir": 50, "expected_loi": 5, "field_time": 20, "qualifications": [], "live_url": "https://my.survey.com?survey_id=1234", "test_url": "https://my.survey.com?survey_id=1234&test=1", "feasibility_exclusions": { "enable": false, "start": "20250501", "end": "20250630", "criterias": [], "criteriaSurveys": [ 18887 ], "statuses": [] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "No matching custom respondent status provided. Please check and try again." }
Case 3 - When the valid respondent statuses are sent while updating the survey
Request
Request URL:
PUT <BASE_URL>/buyers/v2/surveys/<SURVEY_ID> headers - access-token: <BUYER_ACCESS_TOKEN>
Request Body:
{ "survey_title": "Survey Test - exclusions", "click_balancing": 0, "survey_category_code": 232, "survey_localization": "en_US", "completes_required": 100, "expected_ir": 50, "expected_loi": 5, "field_time": 20, "qualifications": [], "live_url": "https://my.survey.com?survey_id=1234", "test_url": "https://my.survey.com?survey_id=1234&test=1", "feasibility_exclusions": { "enable": false, "start": "20250501", "end": "20250630", "criterias": [], "criteriaSurveys": [ 18887 ], "statuses": [12, 16, 20, 21, 29] } }
Response
Response Code:
CODE: 200 OK
Response Body:
{ "qbp": { "enable": false }, "qlc": { "enable": false, "multiple_quotas": { "enable": false, "count_by_quota": false, "compensate_by_quota": false } }, "soft_launch": { "enable": false }, "unique_links": { "enable": false }, "click_balancing": 0, "estimated_clicks": 0, "survey_external_id": "", "ps_survey_status": 11, "offer_price": null, "incl_excl": 0, "quota_throttling": false, "url_transform": false, "subscriber_emails": [], "survey_title": "Survey Test - exclusions", "survey_category_code": 232, "completes_required": 100, "field_time": 20, "buyer_message": null, "is_modular_survey": false, "live_url": "https://my.survey.com?survey_id=1234", "billing_id": null, "test_url": "https://my.survey.com?survey_id=1234&test=1", "expected_loi": 5, "expected_ir": 50, "ps_survey_id": 19169, "buyer_surveygroup_ref": null, "buyer_surveygroup_refs": [], "test_ps_survey_entry_link": "http://localhost:3000/#/start-survey?survey_id=19169&ps_redirect_test=1&bsec=a70mx8&supplier_id=23", "survey_localization": "en_US", "uniqueLinks": false, "quotas": [], "qualifications": [], "is_feot_enabled": false, "feot": {}, "survey_grouping": [], "blend_id": "sb15119df6f2", "schedule_launch": { "enable": false, "info": {} }, "price_reco": false, "project_creation_date": "2025-07-07T12:30:21.569Z", "project_last_complete_date": null, "is_dq_enable": false, "mc_count": 0, "tc_count": 0, "basic_token": { "enable": false, "value": null }, "is_pure_price_rate_card_enable": true, "dq_settings": { "purescore_filter_enabled": true, "fp_device_check": true, "fp_fraud_check": true }, "product": "", "pds_ignore_override": false, "supplier_allocation_throttle": false }
Case 4 - When the empty array of respondent statuses are sent while updating the survey
Request -
Request URL:
PUT <BASE_URL>/buyers/v2/surveys/<SURVEY_ID> headers - access-token: <BUYER_ACCESS_TOKEN>
Request Body:
{ "survey_title": "Survey Test - exclusions", "click_balancing": 0, "survey_category_code": 232, "survey_localization": "en_US", "completes_required": 100, "expected_ir": 50, "expected_loi": 5, "field_time": 20, "qualifications": [], "live_url": "https://my.survey.com?survey_id=1234", "test_url": "https://my.survey.com?survey_id=1234&test=1", "feasibility_exclusions": { "enable": false, "start": "20250501", "end": "20250630", "criterias": [], "criteriaSurveys": [ 18887 ], "statuses": [] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "No matching custom respondent status provided. Please check and try again." }