Delete

3min

Delete Zipcode
﻿DELETE  /zipcodes
To delete zipcodes from your account you should make an  HTTP DELETE  request to the Delete Zipcodes endpoint, specifying an array of objects containing a  zipcode  and  domain  property describing the zipcodes you'd like to delete.
Zipcodes can also be deleted visually via the Dashboard.
Zipcode Deletion & Collections
Note that when a zipcode is deleted any requests using that zipcode in their  customer_zipcode  parameter will fail. This includes any requests that use this zipcode and are part of Collections you may already have set up on your account.
For more information about using zip & postal codes with Backyard API please see the zipcodes overview.
Curl
Node.js
Python
PHP
$ curl -X DELETE "https://api.backyardapi.com/zipcodes?api_key=demo" \
  --data '[ { "zipcode": "30339", "domain": "homedepot.com" } ]'
$ curl -X DELETE "https://api.backyardapi.com/zipcodes?api_key=demo" \
  --data '[ { "zipcode": "30339", "domain": "homedepot.com" } ]'
﻿
An example of a successful response to the Delete Zipcodes API is shown below:
JSON
{
  "request_info": {
    "success": true,
    "message": "1 zipcode deleted"
  }
}
{
  "request_info": {
    "success": true,
    "message": "1 zipcode deleted"
  }
}
﻿
﻿
Next Steps
     Zipcodes Overview
     Listing all zipcodes via the Zipcodes API
     Adding a zipcode via the Zipcodes API﻿

Updated 08 Aug 2024

Did this page help you?

List

Overview