Schedule Pause Survey Creation
Case - 1
When the correct schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 201 Created
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 - Schedule Pause", "survey_category_code": 232, "completes_required": 100, "field_time": 20, "buyer_message": null, "is_modular_survey": false, "live_url": "https://take-stage.purespectrum.com/mp_redirection", "billing_id": null, "expected_loi": 5, "expected_ir": 50, "ps_survey_id": 19340, "buyer_surveygroup_ref": null, "buyer_surveygroup_refs": [], "test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/startsurvey?survey_id=19340&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-09-19T11:49:13.150Z", "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, "survey_pause_threshold": 1.24, "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] }, "blend_applied": false, "default_pure_price_override": false }
Case - 2
When scheduled pause config is off for the buyer 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 403 FORBIDDEN
Response Body:
{ "ps_api_response_code": 1018, "ps_api_response_message": "You do not have the Scheduled Pause feature activated. Please ask your PureSpectrum reference to activate it in order to use the feature." }
Case - 3
When the unsupported timezone is sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Unsupported", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause timezone info in the request is unsupported. Please check and try again!" }
Case - 4
When invalid days are sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 8, 9], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause days info in the request seems incorrect, which needs to be in the range of 0-6. Please check and try again!" }
Case - 5
When invalid start time is sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "28:45", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause start_time info in the request seems incorrect, which needs to be in the 24-hour clock format (for example, 14:50). Please check and try again!" }
Case - 6
When invalid duration is sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 8, "minutes": 8 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause duration info in the request seems incorrect, which needs to be in the following format: days (0–6), hours (0–23), and minutes (0, 15, 30, or 45). Please check and try again!" }
Case - 7
When conflicting days and duration are sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 1, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause selected days and duration are conflicting with each other. Please follow the documentation and try again!" }
Case - 8
When minimum duration threshold is not sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 0, "minutes": 0 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause duration info in the request seems incorrect, which needs to be at least 15 minutes. Please check and try again!" }
Schedule Pause Survey Updation (via PUT buyer survey API)
Case - 1
When the correct schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
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 - Schedule Pause", "survey_category_code": 232, "completes_required": 100, "field_time": 20, "buyer_message": null, "is_modular_survey": false, "live_url": "https://take-stage.purespectrum.com/mp_redirection", "billing_id": null, "expected_loi": 5, "expected_ir": 50, "ps_survey_id": 19340, "buyer_surveygroup_ref": null, "buyer_surveygroup_refs": [], "test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/startsurvey?survey_id=19340&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-09-19T11:49:13.150Z", "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, "survey_pause_threshold": 1.24, "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] }, "blend_applied": false, "default_pure_price_override": false }
Case - 2
When scheduled pause config is off for the buyer 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 403 FORBIDDEN
Response Body:
{ "ps_api_response_code": 1018, "ps_api_response_message": "You do not have the Scheduled Pause feature activated. Please ask your PureSpectrum reference to activate it in order to use the feature." }
Case - 3
When the unsupported timezone is sent with schedule pause details while update 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Unsupported", "days": [ 1, 3 ], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause timezone info in the request is unsupported. Please check and try again!" }
Case - 4
When invalid days are sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 8, 9], "start_time": "18:30", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause days info in the request seems incorrect, which needs to be in the range of 0-6. Please check and try again!" }
Case - 5
When invalid start time is sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "28:45", "duration": { "days": 0, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause start_time info in the request seems incorrect, which needs to be in the 24-hour clock format (for example, 14:50). Please check and try again!" }
Case - 6
When invalid duration is sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 8, "minutes": 8 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause duration info in the request seems incorrect, which needs to be in the following format: days (0–6), hours (0–23), and minutes (0, 15, 30, or 45). Please check and try again!" }
Case - 7
When conflicting days and duration are sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 1, "hours": 8, "minutes": 15 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause selected days and duration are conflicting with each other. Please follow the documentation and try again!" }
Case - 8
When minimum duration threshold is not sent with schedule pause details 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 - Schedule Pause", "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://take-stage.purespectrum.com/mp_redirection", "schedule_pause": { "enable": true, "info": [ { "timezone": "America/Los_Angeles", "days": [ 0, 1, 2], "start_time": "23:45", "duration": { "days": 0, "hours": 0, "minutes": 0 } } ] } }
Response
Response Code:
CODE: 400 BAD
Response Body:
{ "ps_api_response_code": 1007, "ps_api_response_message": "Schedule Pause duration info in the request seems incorrect, which needs to be at least 15 minutes. Please check and try again!" }