{"_id":"5de85dbbb0b885003ddf3356","editedParams2":true,"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"},"editedParams":true,"parentDoc":null,"user":"56e371538b32a10e00f79750","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"},"githubsync":"","__v":5,"project":"56e3719a591f620e00bf5095","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-28T19:32:13.778Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"code":"Orbirental API - Bad request.","language":"json","status":400,"name":""}]},"settings":"","examples":{"codes":[{"code":"","language":"text"},{"language":"text","code":""},{"code":"","language":"text"}]},"auth":"required","params":[{"_id":"5722653d49df4f0e00528492","ref":"","in":"body","required":true,"desc":"The unique ID of the property","default":"","type":"string","name":"uid"},{"_id":"5722653d49df4f0e00528491","ref":"","in":"body","required":true,"desc":"The start date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"from"},{"_id":"5722653d49df4f0e00528490","ref":"","in":"body","required":true,"desc":"The end date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"to"},{"_id":"5722653d49df4f0e0052848f","ref":"","in":"body","required":false,"desc":"The nightly rate for this period","default":"0.0","type":"double","name":"amount"},{"_id":"5722653d49df4f0e0052848e","ref":"","in":"body","required":false,"desc":"The minimum amount of nights accepted for booking during this period","default":"1","type":"string","name":"minimumStay"},{"_id":"5df8ae9e3b4a4e001254b81a","ref":"","in":"body","required":false,"desc":"Allow checkin for this date","default":"","type":"boolean","name":"isCheckinAllowed"},{"_id":"5df8ae9e3b4a4e001254b819","ref":"","in":"body","required":false,"desc":"Allow checkout for this date","default":"","type":"boolean","name":"isCheckoutAllowed"}],"url":"/pricingperiods/"},"isReference":false,"order":65,"body":"","excerpt":"This API allows developers to remotely set the nightly rates for properties. This can also be used to interface the Hostfully Platform with a Price Automation / Yield Management service.","slug":"pricingperiods-1","type":"endpoint","title":"/pricingperiods/"}

post/pricingperiods/

This API allows developers to remotely set the nightly rates for properties. This can also be used to interface the Hostfully Platform with a Price Automation / Yield Management service.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

uid:
required
string
The unique ID of the property
from:
required
yyyy-mm-dd
The start date with format YYYY-MM-DD
to:
required
yyyy-mm-dd
The end date with format YYYY-MM-DD
amount:
double0.0
The nightly rate for this period
minimumStay:
string1
The minimum amount of nights accepted for booking during this period
isCheckinAllowed:
boolean
Allow checkin for this date
isCheckoutAllowed:
boolean
Allow checkout for this date

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