Deprecated

We have deprecated the legacy version of Child Age and Gender that required sending three separate qualifications in favor of a single qualification model more consistent with industry norms.

Legacy: 218, 220, 230

New: 232 Described Here

NOTE: Sending Requests using legacy version of Child Age and Gender (218, 220, 230) will result in the targeting being converted to 232. This will only be supported through Q2 2025, at which time Requests with legacy (218, 220, 230) will no longer be supported.

Child Age & Gender Qualification and Condition Codes


Attached please find the new Qualification and Condition Codes for Child Age & Gender (Qualification 232)

Create Survey


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) 

Examples

This example will itemize multiple scenarios as listed below:

// 1.  … 400 completes with kids and 600 without kids
// 2.  … 1000 completes with kids
// 3. 1000 with kids age range 4-12
// 4. 1000 completes with kids; Only Boys
// 5. 1000 completes with kids; 400 with boys, 600 with girls
// 6. 1000 completes with kids; 200 boys, age-range 0-3; 300 boys age-range 4-9; 500 girls
// 7. 400 with kids, 600 without kids; of the 400 with kids, 300 boys age 4-6 100 boys age 7-9

// Scenario-1: 400 completes with kids and 600 without kids
{
  "survey_title": "Automobile Preferences",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 1000,
  "expected_ir": 60,
  "expected_loi": 60,
  "live_url": "http://www.mybuyer.com/surveys_134",
  "test_url": "http://www.mybuyer.com/surveys_134t",
  "field_time": 10,
  "qualifications": [
    {
      "qualification_code": 232,
      "condition_codes": [
        "111", "112", "113", "114", "115", "116", "117", "118", "119", "120",
        "121", "122", "123", "124", "125", "126", "127", "128", "129", "130",
        "131", "132", "133", "134", "135", "136", "137", "138", "139", "140",
        "141", "142", "143", "144", "145", "146", "147", "148", "149", "150",
        "151", "152", "153", "154", "155", "156", "157", "158", "159", "160",
        "161", "162", "163", "164", "165", "166", "167"
      ]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 400,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": [
            "111", "112", "113", "114", "115", "116", "117", "118", "119", "120",
        	"121", "122", "123", "124", "125", "126", "127", "128", "129", "130",
        	"131", "132", "133", "134", "135", "136", "137", "138", "139", "140", 
			"141", "142", "143", "144", "145", "146", "147", "148", "149", "150",
			"151", "152", "153", "154", "155", "156", "157", "158", "159", "160",
			"161", "162", "163", "164", "165", "166"
          ]
        }
      ]
    },
    {
      "buyer_quota_id": "b11112",
      "required_count": 600,
      "criteria": [
        {
          "qualification_code": 232,
          "condition_codes": ["167"]
        }
      ]
    }
  ]
}

// Scenario-2: 1000 completes with kids
{
  // ...
  "qualifications": [
    {
      "qualification_code": 232,
      "child_age_unit": 311, //Years Unit
      "condition_codes": [
        "111", "112", "113", "114", "115", "116", "117", "118", "119", "120",
        "121", "122", "123", "124", "125", "126", "127", "128", "129", "130",
        "131", "132", "133", "134", "135", "136", "137", "138", "139", "140",
        "141", "142", "143", "144", "145", "146", "147", "148", "149", "150",
        "151", "152", "153", "154", "155", "156", "157", "158", "159", "160",
        "161", "162", "163", "164", "165", "166"
      ]
    }
  ]
  // No need to set quotas because all completes will be for respondents with kids
}

// Scenario-3: 1000 with kids age range 4-12
{
  "qualifications": [
    {
      "qualification_code": 232,
      "condition_codes": ["139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156"]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 1000,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156"]
        }
      ]
    }
  ]
}

// Scenario-4: 1000 completes with only Boys
{
  "qualifications": [
    {
      "qualification_code": 232,
      "condition_codes": ["133", "135", "137", "139", "141", "143", "145", "147", "149", "151", "153", "155", "157", "159", "161", "163", "165"]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 1000,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["133", "135", "137", "139", "141", "143", "145", "147", "149", "151", "153", "155", "157", "159", "161", "163", "165"]
        }
      ]
    }
  ]
}

// Scenario-5: 1000 completes with Kids, 400 boys 600 girls
{
  "qualifications": [
    {
      "qualification_code": 232,
      "condition_codes": ["133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 400,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["133", "135", "137", "139", "141", "143", "145", "147", "149", "151", "153", "155", "157", "159", "161", "163", "165"] //Boys from 0 to 17
        }
      ]
    },
    {
      "buyer_quota_id": "b11112",
      "required_count": 600,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["134", "136", "138", "140", "142", "144", "146", "148", "150", "152", "154", "156", "158", "160", "162", "164", "166"] //Girl from 0 to 17
        }
      ]
    }
  ]
}

// Scenario-6: 1000 completes with kids; 200 boys, age-range 0-3; 300 boys age-range 4-9; 500 girls
{
  "qualifications": [
    {
      "qualification_code": 232,
      "child_age_unit": 311, //Years Unit
      "condition_codes": ["133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 200,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"],
        }
      ]
    },
    {
      "buyer_quota_id": "b11112",
      "required_count": 300,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["133", "135", "137"]
        }
      ]
    },
    {
      "buyer_quota_id": "b11113",
      "required_count": 500,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["140", "142", "144", "146", "148", "150"]
        }
      ]
    }
  ]
}

// Scenario-7: 400 with kids, 600 without kids; of the 400 with kids, 300 boys age 4-6 100 boys age 7-9
{
  "qualifications": [
    {
      "qualification_code": 232,
      "condition_codes": ["133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "b11111",
      "required_count": 400,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"]
        }
      ]
    },
    {
      "buyer_quota_id": "b11112",
      "required_count": 600,
      "criteria": [
        {"qualification_code": 232, "condition_codes": ["167"]} //Don't have children
      ]
    },
    {
      "buyer_quota_id": "b11113",
      "required_count": 300,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["139", "141", "143"] //4 to 6
        }
      ]
    },
    {
      "buyer_quota_id": "b11114",
      "required_count": 100,
      "criteria": [
        {
          "qualification_code": 232,
          "child_age_unit": 311, //Years Unit
          "condition_codes": ["145", "147", "149"] //7 to 9
        }
      ]
    }
  ]
}

Response

{
  "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": 1,
  "incl_excl": 0,
  "quota_throttling": false,
  "url_transform": false,
  "subscriber_emails": [],
  "survey_title": "ODECIO TEST API ",
  "survey_category_code": 224,
  "completes_required": 100,
  "field_time": 2,
  "buyer_message": null,
  "is_modular_survey": false,
  "live_url": "https://purespectrum.decipherinc.com/survey/selfserve/57d/ong/API-postman-test-ForcedExposure-TM-561/PgIMDJDkY?list=127&i223=[%%223%%]&i212=[%%212%%]&i211=[%%211%%]&i244=[%%244%%]&i245=[%%245%%]&i215=[%%215%%]&i216=[%%216%%]&i217=[%%217%%]&i213=[%%213%%]&i218=[%%218%%]&i229=[%%229%%]",
  "billing_id": "PS1109554",
  "test_url": "https://purespectrum.decipherinc.com/survey/selfserve/57d/ong/API-postman-test-ForcedExposure-TM-561/PgIMDJDkY?list=127&i223=[%%223%%]&i212=[%%212%%]&i211=[%%211%%]&i244=[%%244%%]&i245=[%%245%%]&i215=[%%215%%]&i216=[%%216%%]&i217=[%%217%%]&i213=[%%213%%]&i218=[%%218%%]&i229=[%%229%%]",
  "expected_loi": 6,
  "expected_ir": 80,
  "ps_survey_id": 1109554,
  "buyer_surveygroup_ref": null,
  "buyer_surveygroup_refs": [],
  "test_ps_survey_entry_link": "https://staging.spectrumsurveys.com/#/start-survey?survey_id=1109554&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
  "survey_localization": "en_US",
  "uniqueLinks": false,
  "quotas": [
    {
      "buyer_quota_id": "b11112",
      "quota_title": "",
      "ps_quota_id": "7af27f57-24b6-4da8-8e5f-8b6bc14a11db",
      "required_count": 600,
      "criteria": [
        {
          "qualification_code": 232,
          "condition_codes": ["167"],
          "child_age_unit": 311
        }
      ]
    },
    {
      "buyer_quota_id": "b11111",
      "quota_title": "",
      "ps_quota_id": "33c2c98f-06bb-4637-97dd-802e5f33ca57",
      "required_count": 400,
      "criteria": [
        {
          "qualification_code": 232,
          "condition_codes": [
            "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "135", "136", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "208", "209", "210", "211", "137", "138", "212", "213", "214", "215", "216", "217", "218", "219", "220", "221", "222", "223", "224", "225", "226", "227", "228", "229", "230", "231", "232", "233", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"
          ],
          "child_age_unit": 311
        }
      ]
    }
  ],
  "qualifications": [
    {
      "condition_codes": [
        "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "208", "209", "210", "211", "212", "213", "214", "215", "216", "217", "218", "219", "220", "221", "222", "223", "224", "225", "226", "227", "228", "229", "230", "231", "232", "233"
      ],
      "qualification_code": 232
    }
  ],
  "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-02-11T18:29:03.921Z",
  "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": false,
  "dq_settings": {
    "purescore_filter_enabled": true,
    "fp_device_check": true,
    "fp_fraud_check": true
  },
  "product": "",
  "pds_ignore_override": false,
  "supplier_allocation_throttle": true,
  "blend_applied": false
}

Requests using 218 can be used, but they will be transformed to 232

Example:

//Request
{
  "survey_category_code": 224,
  "survey_localization": "en_US",
  "completes_required": 100,
  "expected_ir": 80,
  "expected_loi": 6,
  "field_time": 2,
  "offer_price": 1,
  "survey_title": "ODECIO TEST API ",
  "qualifications": [
    {
      "qualification_code": 218,
      "condition_codes": [
        "111",
        "112"
      ]
    }
  ],
  "quotas": [
    {
      "buyer_quota_id": "demographicsps218NoChildren",
      "required_count": 100,
      "criteria": [
        {
          "qualification_code": 218,
          "condition_codes": [
            "111"
          ]
        }
      ]
    },
    {
      "buyer_quota_id": "demographicsps218HaveChildren",
      "required_count": 100,
      "criteria": [
        {
          "qualification_code": 218,
          "condition_codes": [
            "112"
          ]
        }
      ]
    }
  ],
  "live_url": "https://test-link.com",
  "test_url": "https://test-link.com"
}

Response:

{
  "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": 1,
  "incl_excl": 0,
  "quota_throttling": false,
  "url_transform": false,
  "subscriber_emails": [],
  "survey_title": "ODECIO TEST API ",
  "survey_category_code": 224,
  "completes_required": 100,
  "field_time": 2,
  "buyer_message": null,
  "is_modular_survey": false,
  "live_url": "https://purespectrum.decipherinc.com/survey/selfserve/57d/ong/API-postman-test-ForcedExposure-TM-561/PgIMDJDkY?list=127&i223=[%%223%%]&i212=[%%212%%]&i211=[%%211%%]&i244=[%%244%%]&i245=[%%245%%]&i215=[%%215%%]&i216=[%%216%%]&i217=[%%217%%]&i213=[%%213%%]&i218=[%%218%%]&i229=[%%229%%]",
  "billing_id": "PS1109575",
  "test_url": "https://purespectrum.decipherinc.com/survey/selfserve/57d/ong/API-postman-test-ForcedExposure-TM-561/PgIMDJDkY?list=127&i223=[%%223%%]&i212=[%%212%%]&i211=[%%211%%]&i244=[%%244%%]&i245=[%%245%%]&i215=[%%215%%]&i216=[%%216%%]&i217=[%%217%%]&i213=[%%213%%]&i218=[%%218%%]&i229=[%%229%%]",
  "expected_loi": 6,
  "expected_ir": 80,
  "ps_survey_id": 1109575,
  "buyer_surveygroup_ref": null,
  "buyer_surveygroup_refs": [],
  "test_ps_survey_entry_link": "https://qa8-api.spectrumsurveys.com/#/start-survey?survey_id=1109575&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
  "survey_localization": "en_US",
  "uniqueLinks": false,
  "quotas": [
    {
      "buyer_quota_id": "demographicsps218NoChildren",
      "quota_title": "",
      "ps_quota_id": "cab8ff32-5ecb-437e-8f47-6f6fca059158",
      "required_count": 100,
      "criteria": [
        {
          "qualification_code": 232,
          "condition_codes": [
            "167"
          ],
          "child_age_unit": 311
        }
      ]
    },
    {
      "buyer_quota_id": "demographicsps218HaveChildren",
      "quota_title": "",
      "ps_quota_id": "54a3874e-a96c-48aa-ab64-aa26ddd0a6a2",
      "required_count": 100,
      "criteria": [
        {
          "qualification_code": 232,
          "condition_codes": [
            "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "135", "136", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "208", "209", "210", "211", "137", "138", "212", "213", "214", "215", "216", "217", "218", "219", "220", "221", "222", "223", "224", "225", "226", "227", "228", "229", "230", "231", "232", "233", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166"
          ],
          "child_age_unit": 311
        }
      ]
    }
  ],
  "qualifications": [
    {
      "condition_codes": [
        "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "208", "209", "210", "211", "212", "213", "214", "215", "216", "217", "218", "219", "220", "221", "222", "223", "224", "225", "226", "227", "228", "229", "230", "231", "232", "233"
      ],
      "qualification_code": 232
    }
  ],
  "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-02-11T19:46:07.966Z",
  "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": false,
  "dq_settings": {
    "purescore_filter_enabled": true,
    "fp_device_check": true,
    "fp_fraud_check": true
  },
  "product": "",
  "pds_ignore_override": false,
  "supplier_allocation_throttle": true,
  "blend_applied": false
}