Our updated BUY API documentation is available here.
We hope you enjoy the new experience! Reach out to us with your feedback or questions on supportbuyapi@purespectrum.com
Happy programming! 🎉

Create Survey

Zipcode qualification code is 229

(testcase id: bapit-4)

Request

POST $apihost/$basepath/surveys

($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)

Parameters:

Body:

{
  "survey_title": "US Zipcode bapit-4",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 1000,
  "expected_ir": 60,
  "expected_loi": 60,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,
  "qualifications": [
    {
      "qualification_code": 229,
      "condition_codes": [
        "90210", "90025", "03070"
      ]
    }
  ]
}

Result

Response Code

201

Response Body

 {
  "survey_title": "US Zipcode bapit-4",
  "survey_category_code": 231,
  "completes_required": 1000,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,
  "offer_price": null,
  "ps_survey_status": 11,
  "expected_loi": 60,
  "expected_ir": 60,
  "ps_survey_id": 3431,
  "mod_on": 1490013229047,
  "crtd_on": 1490011568138,
  "test_ps_survey_entry_link": "http://dev.spectrumsurveys.com:3500/startsurvey?survey_id=3431&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
  "survey_localization": "en_US",
  "qualifications": [
    {
      "condition_codes": [
        "03070",
        "90025",
        "90210"
      ],
      "qualification_code": 229
    }
  ],
  "quotas": []
}

Notes

Supporting notes

Survey with US Zipcodes qualifications