Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sometimes, zipcode and postal code lists may be very large (>10,000 codes), causing issues in API performance.  You may pass in an optional query string parameter in the GET calls, "&postcoderef=1" which will substitute the "condition_codes" array of zipcodes, with an array containing one postal code list reference id.

Info

We support wildcard characters in buyer uploaded postal code lists.  If the character * is present within the postal code, a respondent may enter any character that is valid according to the country's regex format to qualify.  E.G. zipcode 931** may correspond to 93117 or 93121.

Usage


Code Block
Targeting Criteria Snippet Without Query String Parameter:

GET /suppliers/v2/surveys/:survey_id
{
	"qualification_code":229,
	"condition_codes":[
		"01234",
		"01235",
		"01236"
	]
}

Targeting Criteria Snippet With Query String Parameter:
GET /suppliers/v2/surveys/:survey_id?post_code_ref=1
{
	"qualification_code":229,
	"condition_codes":[
		"a1bc0a0aa322ca"
	]
}

GET /suppliers/v2/postcodes/a1bc0a0aa322ca
{
	"01234",
	"01235",
	"01236"
}

...