{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/photos","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -k -X POST \\\n  https://api.orbirental.com/v1/photos \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -H 'X-ORBIRENTAL-APIKEY: [YOUR_API_KEY]' \\\n  -d '{\n        \"propertyUid\":\"03134e91-5cd9-3333-84ee-67427e112aac\",\n        \"url\":\"https://www.myimages.com/5d742d19-dd57-4525-bc80-fe647e877bd4\"\n}'"}]},"settings":"","results":{"codes":[{"status":200,"name":"","code":"{\n  \"uid\": \"d1011595-98eb-4bc7-9e5b-7e914798e56c\",  //the uid of the new photo\n  \"description\": \"description\",\n  \"displayOrder\": 1,\n  \"url\": \"https://orbirental-images.s3.amazonaws.com/d1011595-98eb-4bc7-9e5b-7e914798e56c\"\n}","language":"json"},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Agency not found.","language":"text","status":409}]},"method":"post","params":[{"name":"url","type":"string","default":"","desc":"URL of the photo to upload from another web location","required":true,"in":"body","ref":"","_id":"56e792971e071c22001a0488"},{"name":"propertyUid","type":"string","default":"","desc":"The unique id of the property","required":true,"in":"body","ref":"","_id":"56e788a19b25270e001d1269"}]},"next":{"description":"","pages":[]},"title":"/photos","type":"endpoint","slug":"photos","excerpt":"Create a new photo for the property represented by propertyUid. NOTE that this API is not supported on our sandbox server. It is only supported in production.","body":"","updates":[],"order":48,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf338c","project":"56e3719a591f620e00bf5095","version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"user":"56e371538b32a10e00f79750","createdAt":"2018-10-22T08:08:10.143Z","__v":9,"parentDoc":null}

post/photos

Create a new photo for the property represented by propertyUid. NOTE that this API is not supported on our sandbox server. It is only supported in production.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

url:
required
string
URL of the photo to upload from another web location
propertyUid:
required
string
The unique id of the property

Examples


Result Format


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