{"_id":"5bba8b01219c3e000376a42f","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":35,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"5bba5e5d7ba7710003bd902a","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-07T19:28:29.644Z","from_sync":false,"order":25,"slug":"territories-api","title":"Territories API"},"user":"5a6a26281895510045b2cd40","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-07T22:38:57.287Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"text","code":"No Output","name":""},{"status":500,"name":"Destination Territory Invalid","language":"text","code":"Internal Server Error"},{"status":400,"name":"Item Type Incompatible","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"message\": \"Wrong territory type\"\n        }\n    ]\n}"},{"status":400,"name":"Body Parameter Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#\",\n            \"message\": \"property invalid is used for a schema that does not allow additional properties\"\n        }\n    ]\n}"},{"status":404,"name":"Territory Not Found","language":"text","code":"Territory with id T50baf685a086ab3610a95061 does not exist."},{"code":"Territory with id undefined does not exist.","language":"text","name":"Destination Territory Not Found","status":404}]},"settings":"","examples":{"codes":[{"language":"http","code":"POST https://ioe.droplit.io/api/territories/T5bba743ca046af36c0a252f5/move HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"destinationTerritoryId\" : \"T57b26c89a14fa832caa75bd1\"\n}"}]},"method":"post","auth":"required","params":[{"_id":"5bba8ca2dc7f900003fd9adc","ref":"","in":"path","required":true,"desc":"The ID of the territory to be moved.","default":"","type":"string","name":"id"},{"_id":"5bba8fcb219c3e000376a436","ref":"","in":"body","required":true,"desc":"The ID of the destination territory.","default":"","type":"string","name":"destinationTerritoryId"},{"_id":"5bba8fcb219c3e000376a435","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"}],"url":"/api/territories/:id/move"},"isReference":false,"order":7,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"WARNING\",\n  \"body\": \"The `itemType` of the destination territory MUST be `territory`.\"\n}\n[/block]","excerpt":"Move a territory to be the child of another territory.","slug":"get-permissions","type":"endpoint","title":"Move a territory."}

postMove a territory.

Move a territory to be the child of another territory.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the territory to be moved.

Body Params

destinationTerritoryId:
required
string
The ID of the destination territory.

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "WARNING", "body": "The `itemType` of the destination territory MUST be `territory`." } [/block]

User Information

Try It Out

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