Source: https://developers.woosmap.com/api-reference/zones-api/put-zones/ > For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://developers.woosmap.com/llms.txt # Update the Zones # Update the Zones PUT https://api.woosmap.com/zones Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused. ### Authorization [`private_key`](#authorization-woosmap-platform-api-reference-privateapikeyauth) apiKeyquery A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key). ### Request Body application/json The request body of Zones Update must be formatted as JSON. [`zones`](#req-zones) object[]required The Zones collection #Show 6 propertiesHide 6 properties zones.[`zone_id`](#req-zones-zone-id) stringrequired A textual identifier that uniquely identifies a Zone. Example:`ZoneA` zones.[`description`](#req-zones-description) string Textual description of your Zone Example:`Delivery Zone for Store A` zones.[`store_id`](#req-zones-store-id) stringrequired A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+` Example:`STORE_ID_12345` zones.[`polygon`](#req-zones-polygon) stringrequired Zone geometry polygon as **Well Known Text**. WKT defines how to represent geometry of one object (cf. [https://en.wikipedia.org/wiki/Well-known\_text](https://en.wikipedia.org/wiki/Well-known_text)). Your zones could be complex and multipart polygons. Example:`POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))` zones.[`types`](#req-zones-types) string[] Contains an array of types describing the Zone. Example: ```json [ "delivery", "san_francisco_west" ] ``` zones.[`status`](#req-zones-status) string the status as string Example:`ok` ##### Example ```json { "zones": [ { "zone_id": "ZoneA", "description": "Delivery Zone for Store A", "store_id": "STORE_ID_123456", "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", "types": [ "delivery" ] }, { "zone_id": "ZoneB", "description": "Delivery Zone for Store B", "store_id": "STORE_ID_123456", "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))", "types": [ "delivery" ] }, { "zone_id": "ZoneC", "description": "Delivery Zone for Store C", "store_id": "STORE_ID_45678", "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))", "types": [ "delivery" ] } ] } ``` ### Response 200application/json Zones successfully updated [`status`](#resp-200-status) string the status of the 2OO Zones response Example:`success` [`message`](#resp-200-message) string message returned with the 2OO Zones request Example:`Zones successfully updated.` ### Errors #400 Invalid. The data is not a valid JSON. `application/json` [`status`](#err-400-status) string the status of the 400 response Example:`error` [`value`](#err-400-value) string the value of request causing the Error Example:`The request is invalid, the data is not a valid JSON.` #401 Unauthorized. Incorrect authentication credentials. `application/json` [`detail`](#err-401-detail) string Details for the credentials error Example:`Incorrect authentication credentials. Please check or use a valid API Key` #403 Forbidden. This Woosmap API is not enabled for this project. `application/json` [`detail`](#err-403-detail) string Details for the forbidden error message Example:`This Woosmap API is not enabled for this project.` ```shell curl -L -X PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \ -H 'content-type: application/json' \ -d '{ "zones": [ { "zone_id": "ZoneA", "description": "Delivery Zone for Store A", "store_id": "STORE_ID_45678", "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", "types": [ "delivery" ] } ] }' ``` ```python import requests import json url = "https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY" payload = json.dumps({ "zones": [ { "zone_id": "ZoneA", "description": "Delivery Zone for Store A", "store_id": "STORE_ID_45678", "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", "types": [ "delivery" ] } ] }) headers = { 'content-type': 'application/json' } response = requests.request("PUT", url, headers=headers, data=payload) print(response.text) ``` ```javascript const axios = require('axios'); let data = JSON.stringify({ "zones": [ { "zone_id": "ZoneA", "description": "Delivery Zone for Store A", "store_id": "STORE_ID_45678", "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", "types": [ "delivery" ] } ] }); let config = { method: 'put', maxBodyLength: Infinity, url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY', headers: { 'content-type': 'application/json' }, data : data }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); ``` ```json { "status": "ok", "message": "Zones successfully added." } ``` ```json { "status": "error", "value": "The request is invalid, the data is not a valid JSON." } ``` ```json { "detail": "Incorrect authentication credentials. Please check or use a valid API Key" } ``` ```json { "detail": "This Woosmap API is not enabled for this project." } ```