This metadata API is used to retrieve ZIP or postal code information for supported countries. It helps in configuring zipcode-level geo-targeting in deal setup.
Note: This API is designed to filter zip codes by a numeric string using the search parameter.
Support Center
GET https://apis.demand.ssp.inmobi.com/v1/meta/zip-code
| Field Name | Type | Is mandatory (Y/N)? | Description |
|---|---|---|---|
| Authorization | String | Y | Bearer token for authentication (Bearer <token>) |
| X-USER-ID | String | Y | The ID of the user making the request |
| X-INMOBI-ORG-ID | String | Y | The organization ID associated with the user |
| Content-Type | String | Y | Specifies the media type of the request body. Use: application/json |
| Field Name | Type | Is mandatory (Y/N)? | Description |
|---|---|---|---|
| search | String | Y | Zip code or part of it to filter the results |
curl -X GET "/api/public/meta/zip-code?search=5600&country_id=11&page_num=1&page_size=50" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"
{
"data": {
"countries": [
{
"id": 11,
"name": "India",
"zipcodes": [
{ "id": 1, "code": "560064" },
{ "id": 3, "code": "560078" },
{ "id": 5, "code": "560051" }
]
}
],
"page_num": 1,
"num_items": 3,
"next_page": false,
"total_items": 3,
"total_pages": 1
}
}
By installing this SDK update, you agree that your Children Privacy Compliance setting remains accurate or that you will update that setting, whenever there is a change in your app's audience. You may update the app's Children Privacy Compliance settings at https://publisher.inmobi.com/my-inventory/app-and-placements.