Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 10 Next »

Add income quotas to the survey created in example Survey with Age, Income, Gender Qualifications and Quotas. Note that in the income quotas, the ranges do not overlap. The second income quota starts at 70,001.  You should deactivate any existing quotas you no longer wish to use.

bapit-15

Request

PUT $apihost/$basepath/surveys/5000/

($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": "Sample Survey for Age Income Gender bapit-2",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 1000,
  "expected_ir": 60,
  "expected_loi": 60,
  "offer_price": 4.5,
  "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": 211,
      "condition_codes": [
        "111", "112"
      ]
    },
    {
      "qualification_code": 212,
      "range_sets": [
        {
          "from": 21,
          "to": 29,
          "units": 311
        },
        {
          "from": 40,
          "to": 59,
          "units": 311
        }
      ]
    },
    {
      "qualification_code": 213,
      "range_sets": [
        {
          "from": 50000,
          "to": 100000,
          "units": 321
        }
      ]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "qb12",
      "required_count": 500,
      "criteria": [{"qualification_code": 211,"condition_codes": ["111"]}]
    },
    {
      "buyer_quota_id": "qb13",
      "required_count": 500,
      "criteria": [{"qualification_code": 211,"condition_codes": ["112"]}]
    },
    {
      "buyer_quota_id": "qb14",
      "required_count": 200,
      "criteria": [{"qualification_code": 212,"range_sets": [{"from": 21,"to": 25,"units": 311}]}]
    },
    {
      "buyer_quota_id": "qb15",
      "required_count": 300,
      "criteria": [{"qualification_code": 212,"range_sets": [{"from": 26,"to": 29,"units": 311}]}]
    },
    {
      "buyer_quota_id": "qb16",
      "required_count": 500,
      "criteria": [{"qualification_code": 212,"range_sets": [{"from": 40,"to": 59,"units": 311}]}]
    },
    {
      "buyer_quota_id": "qb17",
      "required_count": 700,
      "criteria": [{"qualification_code": 213,"range_sets": [{"from": 50000,"to": 75000,"units": 321}]}]
    },
    {
      "buyer_quota_id": "qb18",
      "required_count": 300,
      "criteria": [{"qualification_code": 213,"range_sets": [{"from": 75001,"to": 100000,"units": 321}]}]
    }
  ]
}

Response


Response Code

200

Response Body

{
  "ps_api_response_code": 1000,
  "ps_api_response_message": "Purespectrum Custom API Response Message"
}
  • No labels