{"_id":"582789abbe5c080f00a5a846","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"__v":1,"user":"573b7f42fdc9d320001b777d","category":{"_id":"582789abbe5c080f00a5a804","__v":0,"project":"568bdc1483d2061900d86cdc","version":"582789aabe5c080f00a5a7fe","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:30:25.315Z","from_sync":false,"order":16,"slug":"zones","title":"Zones"},"parentDoc":null,"project":"568bdc1483d2061900d86cdc","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T02:41:40.514Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":" "},{"code":"{\n  \"errorType\": \"InvalidParams\",\n  \"errors\": [\n    {\n      \"in\": \"body\",\n      \"message\": \"expected field to be a object\",\n      \"path\": \"meta\"\n    }\n  ]\n}","name":"","status":400,"language":"json"},{"status":401,"language":"text","code":""},{"status":403,"language":"text","code":""},{"code":"Zone with id Z573bd060ae9ac9419f028b64 does not exist.","status":404,"language":"text"}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"PUT https://ioe.droplit.io/api/zones/Z573bd060ae9ac9419f028b63 HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n  \"meta\": {\n    \"$label\": \"My zone\"\n  }\n}"},{"name":"droplit console","language":"text","code":"droplit zone update"}]},"method":"put","auth":"required","params":[{"_id":"573bd6642cf9af3200d58911","ref":"","in":"path","required":true,"desc":"[zone](doc:zones) id or [alias](doc:aliases)","default":"","type":"string","name":"id"},{"_id":"573bd6642cf9af3200d58910","ref":"","in":"body","required":false,"desc":"[metadata](doc:metadata) attached to the [zone](doc:zones)","default":"","type":"object","name":"meta"},{"_id":"573bd6642cf9af3200d5890f","ref":"","in":"body","required":false,"desc":"an [alias](doc:aliases) for the [zone](doc:zones)","default":"","type":"string","name":"alias"},{"_id":"573bd6642cf9af3200d5890e","ref":"","in":"body","required":false,"desc":"item ids to add under the [zone](doc:zones)","default":"","type":"array_string","name":"items"},{"_id":"58464a4c0cd3b80f00aead08","ref":"","in":"header","required":false,"desc":"[metadata](doc:metadata) prefix","default":"$","type":"string","name":"x-system-meta-prefix"}],"url":"/zones/:id"},"isReference":true,"order":3,"body":"You can use this endpoint to update basic information about a zone.\n\nTo update a zone's items use [/api/zones/:id/items](https://docs.droplit.io/docs/zones-update-items)","excerpt":"Update zone record","slug":"update-zones","type":"endpoint","title":"Update"}

putUpdate

Update zone record

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
[zone](doc:zones) id or [alias](doc:aliases)

Body Params

meta:
object
[metadata](doc:metadata) attached to the [zone](doc:zones)
alias:
string
an [alias](doc:aliases) for the [zone](doc:zones)
items:
array of strings
item ids to add under the [zone](doc:zones)

Headers

x-system-meta-prefix:
string$
[metadata](doc:metadata) prefix

Examples


Result Format


Documentation

You can use this endpoint to update basic information about a zone. To update a zone's items use [/api/zones/:id/items](https://docs.droplit.io/docs/zones-update-items)

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}