{"_id":"5de85dbbb0b885003ddf3388","project":"56e3719a591f620e00bf5095","version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","githubsync":"","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-05T13:55:11.817Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[]},"settings":"","results":{"codes":[{"name":"","code":"{\n  \"summary\": \"long description\",\n  \"name\": \"name\",\n  \"shortSummary\": \"Short summary\",\n  \"notes\": \"notes\",\n  \"access\": \"access\",\n  \"transit\": \"transit\",\n  \"interaction\": \"interaction\",\n  \"neighborhood\": \"Neighborhoond\",\n  \"locale\": \"en_US\",\n  \"space\": \"space\"\n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Service Provider not found.","language":"text","status":409}]},"auth":"required","params":[{"_id":"5923600aa341250f008c701e","ref":"","in":"path","required":true,"desc":"Unique ID of the property","default":"","type":"string","name":"uid"},{"_id":"59235f547180400f00049012","ref":"","in":"body","required":false,"desc":"en_US, fr_FR, es_ES, de_DE, nl_NL, pt_PT","default":"en_US","type":"string","name":"locale"},{"_id":"5bc6bbef8d41a2005c328104","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"name"},{"_id":"5b1696b0f4ae2500039441d0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"summary"},{"_id":"5bc6bbef8d41a2005c328103","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shortSummary"},{"_id":"5b1696b0f4ae2500039441cf","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"notes"},{"_id":"5b1696b0f4ae2500039441ce","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"transit"},{"_id":"5b1696b0f4ae2500039441cd","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"interaction"},{"_id":"5b1696b0f4ae2500039441cc","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"neighborhood"},{"_id":"5b1696b0f4ae2500039441cb","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"space"},{"_id":"5b1699e4f4ae25000394428c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"access"}],"url":"/propertydescriptions/:uid"},"isReference":false,"order":62,"body":"","excerpt":"Edit or create a property description","slug":"propertydescriptionsuid-2","type":"endpoint","title":"/propertydescriptions/:uid"}

put/propertydescriptions/:uid

Edit or create a property description

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
Unique ID of the property

Body Params

locale:
stringen_US
en_US, fr_FR, es_ES, de_DE, nl_NL, pt_PT
name:
string
summary:
string
shortSummary:
string
notes:
string
transit:
string
interaction:
string
neighborhood:
string
space:
string
access:
string

Result Format


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 }}