API Change Log
(page 2 )
Hello developer community! Welcome to the API Change Log. This topic is dedicated to important updates about the OwnerRez APIs. We recommend you watch this topic to be alerted about changes that may impact your applications.
Happy coding!
[Changes effective October 7, 2026]
Create owner bookings through v2/bookings:
POST v2/bookings now accepts an optional type: booking, block, or owner. Omitting it behaves as before.
- Owner bookings require the Property Management module.
- The guest is always the property's owner contact. Don't send
guest_id. generate_chargesadds the property's surcharges and taxes but no rent. Surcharges limited to guest bookings are skipped.- The owner contact gets no guest confirmation email.
{
"type": "owner",
"property_id": 16064,
"arrival": "2026-11-13",
"departure": "2026-11-16",
"adults": 2,
"generate_charges": true
}
Other changes:
is_blockstill works but is deprecated in favor oftype.- PATCH v2/bookings/{id} can't change a booking's
type. - Guest bookings created through v2/bookings now get the property's cancellation policy.
[Change effective October 14, 2026]
v2 properties now return each property's stay, booking window, and payment rules, plus audit timestamps and culture fields. Pricing and availability partners can read the same limits OwnerRez enforces, such as Max Availability, without scraping settings.
New rules object on v2 properties:
GET v2/propertiesaccepts a newinclude_rulesquery parameter (defaultfalse). Set it totrueto add arulesobject to each property in the list.GET v2/properties/{id}now always includesrules,tags,fields, andlisting_numbers. It takes no include parameters.
rules contains:
- Stay and changeover:
min_nights,max_nights,min_holiday_nights,min_weekend_nights,min_gap_nights,min_gap_nights_is_override,require_gap_nights,min_disallow_gap_nights,max_disallow_gap_nights,arrival_days,departure_days,weekend_type - Booking window:
min_hours_before_arrival,max_days_before_arrival,max_days_before_arrival_is_departure_blocked - Policy:
require_confirmation_for_online_bookings,cancellation_policy_id,quote_expiration_days - Payments and holds:
first_payment_rule,first_payment_amount,second_payment_rule,second_payment_days,security_deposit_rule,security_deposit_type,security_deposit_amount,security_deposit_days,security_deposit_release_days,security_deposit_release_remind_me,pending_hours_for_credit_card,pending_hours_for_check,pending_hours_for_custom,days_before_arrival_for_check,days_before_arrival_for_custom,pending_for,pending_action,send_payment_reminder,send_security_deposit_reminder,allowed_payment_mode,travel_insurance_rule,no_agreement
The API reference lists every field's description and the allowed values for the enum fields.
Example:
GET v2/properties?include_rules=true
{
"items": [
{
"id": 16064,
"time_zone": "America/New_York",
...
"rules": {
"min_nights": 2,
"max_nights": 28,
"require_gap_nights": 1,
"arrival_days": "friday, saturday",
"min_hours_before_arrival": 24,
"max_days_before_arrival": 365,
"max_days_before_arrival_is_departure_blocked": false,
"require_confirmation_for_online_bookings": false,
"quote_expiration_days": 3,
...
}
}
],
"limit": 20,
"offset": 0
}
Reading the booking window:
max_days_before_arrivalis how many days ahead a stay may arrive, counted from today in the property'stime_zone(or the account's time zone whentime_zoneis null).min_hours_before_arrivalis the minimum hours between now and arrival.- The window limits arrival only. When
max_days_before_arrival_is_departure_blockedisfalse(the default), a stay that arrives inside the window may depart after it, so nights past the window are not unavailable. When it istrue, the departure must also fall inside the window. - 365 is the default
max_days_before_arrival, and many properties have never changed it. arrival_daysanddeparture_dayslist the allowed days, comma-separated. Null allows any day of the week.- All values are relative day and hour counts; no dates are computed for you. For per-night availability, use
v2/calendar.
New fields on every property:
GET v2/properties and GET v2/properties/{id} now return:
created_utcandupdated_utc.display_culture: the property's culture override, such asen-US. Null when the property uses the account's culture.currency_codeis unchanged and still returns the property's resolved currency.default_description_locale: the locale of the property's default listing description, such asenorfr, or null.
{
"id": 16064,
"created_utc": "2023-04-11T18:22:05Z",
"updated_utc": "2026-10-02T14:09:51Z",
"currency_code": "EUR",
"display_culture": "fr-FR",
"default_description_locale": "fr",
...
}
Listing numbers fixes:
- When a property is linked twice on the same channel,
listing_numbersreturns the newest link for that channel. PreviouslyGET v2/properties/{id}returned an error for these properties. - A link with a blank listing number no longer replaces a real number from an older link.
- The list and single property endpoints now return the same
listing_numbersfor a property.
[These changes were announced on October 19, 2026. The rate limit goes into effect on November 3, 2026 and the paging changes on January 5, 2027, both at 15:00 UTC]
Breaking Change: offset paging, unknown parameters and mismatched cursors are rejected from January 5, 2027
Every API v2 list endpoint (every response with items and next_page_url) is moving to cursor paging, and offset is now deprecated on all of them. From January 5, 2027 at 15:00 UTC, a list request with offset above 0 returns 400 with code offset_not_supported.
Bookings, deposits, fees, guests, inquiries, messages, payments, quotes, refunds and reviews return a cursor in next_page_url today. Every other list will switch from offset links to cursor links by November 16, 2026.
How to page a list:
Request the first page with no cursor or offset, then request the URL in next_page_url exactly as returned until next_page_url is null. This works today on every list, whichever kind of link it returns, so you can switch now.
- Don't build later page URLs yourself or read values out of
next_page_url. - Pages come one after another: a cursor can't jump to a page number or fetch pages in parallel.
GET /v2/bookings?property_ids=123&since_utc=2026-10-01T00:00:00Z&limit=100
{ "items": [ … ], "next_page_url": "/v2/bookings?property_ids=123&since_utc=2026-10-01T00:00:00Z&limit=100&cursor=eyJ…" }
GET /v2/bookings?property_ids=123&since_utc=2026-10-01T00:00:00Z&limit=100&cursor=eyJ…
With a cursor, rows added or deleted during a walk do not cause duplicates or gaps.
Also rejected on the same dates, on every API v2 endpoint:
- Unknown query parameters return
400with codeunknown_parameter. The parameters each endpoint reads are the ones its API reference page lists; check your requests against it now. The error names each parameter the endpoint doesn't read and, for common misspellings, the documented one. Today these are ignored: on/v2/spotrates,property_idinstead ofproperty_idsreturns every property's overrides, andpage=2returns the first page. Request bodies aren't checked. - Mismatched cursors return
400with codeinvalid_cursor: acursorthe API didn't issue, or one sent with different filters from the request that issued it. Filters are every query parameter exceptcursor,limitandoffset. Today the cursor is dropped and the first page comes back. Requestnext_page_urlexactly as returned, and start again from the first page when you change a filter.
Brownouts:
Before January 5, all three fail with the same 400s during these windows:
- Tuesday, November 17, 2026, 15:00–16:00 UTC
- Tuesday, December 1, 2026, 15:00–19:00 UTC
- Tuesday, December 8, 2026, 15:00 UTC to Wednesday, December 9, 2026, 15:00 UTC
Details: Pagination & ETags and API errors.
Rate limit: 1,000 requests per 5 minutes per access token from November 3, 2026
From November 3, 2026 at 15:00 UTC, each API access token (an app's connection to an account, or a personal access token) may make 1,000 requests in any 5 minutes, whatever addresses the requests come from. This is in addition to the existing per-address limit. A request over either limit returns 429 with a Retry-After header giving the seconds to wait.
[Patch 261021: changes effective October 21, 2026]
Owner bookings on every account
POST v2/bookings with type owner now works on every account. Previously, it required the Property Management module.
- OwnerRez sets an owner booking's contact: the owner assigned to the property for the arrival date or, when no owner is assigned for that date, the property's Owner Booking Contact, which the host sets on the property's General Info page. When neither applies, the request returns a validation error.
- An owner booking's contact changes only when its owner changes.
PATCH v2/bookings/{id}that changes an owner booking'sguest_idreturns a validation error. Previously, the request changed the contact. - An owner booking follows the property's owner-stay rules and needs no rate, and the check and custom payment windows do not apply to it. Previously, it followed the guest booking rules.
Webhook subscription validation
POST v2/webhooksubscriptions now returns 400 for a subscription that can never send a webhook. Previously, these subscriptions saved without an error.
actionmust beentity_create,entity_update,entity_deleteorapplication_authorization_revoked.- An entity action needs a
typethat includes at least one ofbooking,guest,property,message,quote,inquiry,surchargeordiscount. - A
categoryneedstypeto be exactly one ofbooking,guestorproperty, and must be a category thatGET v2/webhooksubscriptions/categorieslists for that type. Previously, an unknowncategorysaved as no category, and the subscription received every change of its type. - An
application_authorization_revokedsubscription stores notypeorcategory.
Authorization revoked webhooks
When an account disconnects an application or closes, or the application revokes the connection's last token, OwnerRez sends application_authorization_revoked to the application's webhook URL and to the URL of each of that connection's application_authorization_revoked subscriptions, once per URL. URLs are compared case-insensitively. Deleting the application sends no revoke. Previously, the revoke went only to the application's webhook URL.
Bug fixes
Webhook subscriptions
GET v2/webhooksubscriptionsreturns only the calling connection's subscriptions, and401to a personal access token. Previously, it returned every connected app's subscriptions, with theirwebhook_url.GETandDELETE v2/webhooksubscriptions/{id}return404for another connection's subscription and401to a personal access token. Previously, GET returned the subscription, and DELETE returned401or500.categorycomes back as its name, such as"dates". Previously, it came back as a number, such as"7".GET v2/webhooksubscriptions/categorieslists each category once. Previously, it listedtransactiontwice.- The app owner email after a
410 Goneunsubscribe uses the webhook unsubscribed alert type. Previously, it used the webhook failed type.
Booking webhooks
- A subscription with category
transactiongets scheduled transaction changes. Previously, it got none. - A tag that a tag automation removed and put back is listed under
relatedwith"action": "entity_update". Previously, it was listed with"entity_delete".
Property search
GET v2/propertysearchreturns an empty list for an emptyproperty_idsand ignores an emptyinclude_tag_idsorexclude_tag_ids. Previously, each returned500.GET v1/properties/searchandGET v1/properties/searchandquoteignore an emptyincludedTagIdsorexcludedTagIds. Previously, each returned500.
Calendar
GET v2/calendarandGET v2/calendar/{property_id}mark a nightorphanonly when no stay can book it. Previously, they marked bookable nightsorphanon properties that limit check-out weekdays, or where a spot rate allows an excluded weekday.
Deposits
GET v2/depositsloads every page. Previously, some pages returned500.
Breaking Change: Quotes now require a guest
[Change effective October 21, 2026]
POST v2/quotes now returns 400 guest_id is required unless test is true. when the request has no guest_id and isn't a test quote. Before this change, OwnerRez saved these quotes, but the guest couldn't book them: saving the Contact section of the quote's payment_form failed, so the form couldn't be submitted.
The same rule applies everywhere a quote is created or changed:
POST v1/quoteswithout a guest now fails validation.- PATCH v2/quotes/{id} can't remove a quote's guest.
- Existing quotes that already have a guest work as before.
Creating a bookable quote:
Create the guest first, then send its ID with the quote, as the Creating Quotes and Bookings article describes. POST v2/guests needs no fields, so you can create the guest before you know who the visitor is and fill in their details later.
{
"property_id": 16064,
"arrival": "2026-11-13",
"departure": "2026-11-16",
"guest_id": 9927183
}
Price checks:
To get pricing without creating a quote, send test: true. A test quote needs no guest, stores nothing and has no payment_form. Please don't create a guest for every price check: those guests fill the host's guest list.
Existing quotes without a guest:
Quotes that were saved without a guest have been deleted, along with their charges. No guest had booked any of them. Quotes that hold dates or that sent an email were kept. Requests for a deleted quote's ID, such as GET v2/quotes/{id}, now return 404. No webhooks were sent for the deletions.
[Changes effective October 28, 2026]
Filter reviews by several properties
GET /v2/reviews now accepts property_ids, a comma-separated list of property ids, like the other list endpoints. property_id still works. A request that sends both gets the reviews of every property in either parameter. Previously, the endpoint ignored property_ids and returned the reviews of every property with a 200.
GET /v2/reviews?property_ids=123,456
Bug fixes
Request errors
- A query or route value that isn't a valid date now returns
400with a message that names the parameter, such as'notadate' is not a valid value for 'from'; expected a date/time.Previously, it returned500. - A query value that isn't a valid integer, number,
trueorfalse, or enum value now returns a400message that names the parameter and the values it accepts, such as'abc' is not a valid value for 'property_id'; expected an integer.Previously, the message did not name the parameter. - A
400for a query value or request body that can't be read or fails validation now carries the codevalidation_failedand itsdoc_url. Previously, these responses had nocodeordoc_url. GET /v2/messageswithoutthreadId,GET /v2/fieldsandGET /v2/tagswithoutentity_idorentity_type,DELETE /v2/tags/bynameandDELETE /v2/fields/bydefinitionwithout one of their required parameters, andGET /v1/guestswithoutqnow return400with one message for each missing parameter, such asA value for the 'threadId' parameter or property was not provided.A misspelled parameter, such asthread_id, counts as missing. Previously, these requests returned405with the codeUnsupportedApiVersion, or404, and the response did not name the parameter.
Lists filtered by since_utc
GET /v2/fees,GET /v2/payments,GET /v2/refunds,GET /v2/inquiriesandGET /v2/quoteswith asince_utcfilter now answer for the exactsince_utcsent, to the millisecond. Previously, a request could get the cached response to an earlier request from the same account whosesince_utcfell in the same second. That response could leave out records changed between the two values.
[Changes take effect on November 2, 2026]
Breaking changes
v2 property rules stop returning no_agreement on November 2, 2026
From November 2, 2026, GET v2/properties with include_rules=true and GET v2/properties/{id} no longer return rules.no_agreement. Read rules.agreement_rule and the other new fields below instead. A property that returns no_agreement true before the release returns agreement_rule not_required after it. Previously, no_agreement true meant the property's bookings signed no rental agreement.
Rental agreement, contact info and security deposit rules on v2 properties
The rules object on GET v2/properties with include_rules=true and on GET v2/properties/{id} has seven new fields. They say which booking sources are asked to sign a rental agreement, confirm their contact info and authorize a security deposit, and which agreement each source signs. Previously, rules held no setting by source, and no_agreement was its only rental agreement field.
Each source is a listing site id, the value a booking's listing_site_id holds and GET v2/listingsites returns. The id 999 (Any Custom Source) stands for direct bookings, which have no listing_site_id, and for the account's own custom sources. A list with no entries is left out of the response, as elsewhere in v2.
agreement_rulesays which sources' bookings sign a rental agreement:required(all sources),not_required(no sources) orrequired_except(all sources except those inagreement_listing_site_ids).agreement_listing_site_idslists the sources whose bookings sign no rental agreement whileagreement_ruleisrequired_except.agreement_idis the rental agreement the property's bookings sign unlesssource_agreementsgives their source a different one. The property keeps it whileagreement_ruleisnot_required. It is left out when the property names no agreement.source_agreementslists the sources whose bookings sign a different agreement, each as alisting_site_idand anagreement_id.contact_information_rulesays which sources' guests are asked to confirm their contact info, with the same three values.contact_information_listing_site_idslists the sources whose guests aren't asked whilecontact_information_ruleisrequired_except. A booking with a rental agreement to sign or a security deposit to authorize asks for contact info whatever these two fields say.security_deposit_listing_site_idslists the sources whose bookings get no automatic security deposit. Other sources followsecurity_deposit_rule.
A booking signs the agreement these fields give its source:
- When
agreement_ruleisnot_required, no source signs one. - When
agreement_ruleisrequired_except, a source inagreement_listing_site_idssigns none.999in that list also excludes direct bookings and custom sources, except a custom source with its own row insource_agreements. - Otherwise, a source with a row in
source_agreementssigns that row's agreement. A direct booking, or a custom source without its own row, signs the agreement in the999row when there is one. - Every other source signs
agreement_id.
No agreement is signed when the property names none, or when the agreement these fields pick is turned off or deleted.
GET v2/properties/16064
{
"id": 16064,
...
"rules": {
"agreement_id": 4123,
"agreement_listing_site_ids": [15],
"agreement_rule": "required_except",
...
"contact_information_listing_site_ids": [15],
"contact_information_rule": "required_except",
...
"security_deposit_listing_site_ids": [15, 999],
...
"source_agreements": [
{
"agreement_id": 4188,
"listing_site_id": 2
}
],
...
}
}
In this example, Airbnb (15) guests sign no agreement and aren't asked to confirm contact info. Vrbo (2) guests sign agreement 4188, and every other source signs agreement 4123. Airbnb bookings, direct bookings and custom sources get no automatic security deposit.
New GET v2/agreements endpoint
GET v2/agreements lists the account's rental agreements with id, name, description, active, created_utc and updated_utc, without the agreement text. These are the ids that agreement_id and source_agreements hold. The optional active parameter filters by status. Without it, the list holds both active and turned-off agreements and leaves out deleted ones. The endpoint is read-only, and there is no endpoint for a single agreement. Previously, the v2 API had no agreements endpoint.
GET v2/agreements?active=true
{
"items": [
{
"active": true,
"created_utc": "2025-04-02T15:12:40Z",
"description": "Standard terms",
"id": 4123,
"name": "Rental Agreement",
"updated_utc": "2026-09-18T20:05:11Z"
},
...
],
...
}
Bookings and quotes made through the API follow the property's rules for their source
A booking made with POST v2/bookings or a quote made with POST v2/quotes takes these rules for its listing_site_id when it is made. One without a listing_site_id counts as a direct booking. Bookings made before November 2 keep the requirements they have.
- The guest signs the agreement the rules give the source, or none. The booking keeps that agreement when the property's rules or the agreement change later. Previously, each agreement's own property and listing site lists decided which bookings signed it, and a built-in agreement applied when none matched. A booking's agreement also followed later changes to the agreements until its guest signed.
- A source in
security_deposit_listing_site_idsgets no automatic security deposit. Previously, a booking or quote made through the API took the property'ssecurity_deposit_rulewhatever its source. - The guest is asked to confirm contact info as
contact_information_rulesays for the source. Previously, every guest was asked.
[Changes effective November 4, 2026]
Cursor links on listings, calendar and property search
GET v2/listings, GET v2/calendar and GET v2/propertysearch now return a cursor link in next_page_url. Previously, they returned an offset link. Request the URL in next_page_url exactly as returned until it is null. The API reference lists cursor on all three and marks offset deprecated.
GET v2/listingsreturns listings by property id, highest first. Previously, it returned them by listing creation date, newest first.GET v2/calendarkeeps its order, by property id, lowest first.GET v2/propertysearchkeeps its order by name and returns properties with the same name by property id. Previously, properties with the same name came back in no fixed order.counton calendar and property search is still the total across all pages.- A page reached through a cursor reports
offset0, on these three lists and on the eight lists under Bug fixes. Previously, it reported the offset of the page. - A request with
offsetand nocursorstill pages by offset, and itsnext_page_urlis a cursor link. From January 5, 2027,offsetabove 0 returns 400, as announced on October 19.
Smoking allowed outdoors only in listing house rules
A property's smoking rule can now be set to allowed outdoors only. For such a property, the HouseRules category in amenity_categories on GET v2/listings/{id}, and on GET v2/listings with includeAmenities=true, holds an amenity with the text Smoking allowed outdoors only. Previously, every property that allowed smoking returned Smoking allowed. A property that allows smoking without that limit still returns Smoking allowed.
GET v1/listings/{id}/summary and GET v1/listings/summary with includeAmenities=true return the same text in the HouseRules category of amenityCategories.
Bug fixes
Paging
GET v2/properties,GET v2/owners,GET v2/fields,GET v2/fielddefinitions,GET v2/tags,GET v2/tagdefinitions,GET v2/listingsitesandGET v2/webhooksubscriptionsreturn acursorlink innext_page_urland return the next page for it, as the API reference describes.countis still the total across all pages. Previously, they returned anoffsetlink.
[Changes effective November 11, 2026]
Party size and stay rent sort on search and quote
GET v1/properties/searchandquote now accepts adults, children and pets, and prices each property for that party. adults defaults to guestsFrom, or 2 when guestsFrom is not sent. children and pets default to 0. Previously, the endpoint ignored these parameters and priced guestsFrom adults, or 2 adults, with no children or pets.
adults below 1, or a negative children or pets, returns 400. With evaluateRules, a property that cannot hold the party returns RuleViolations instead of a price. A request that sends none of the new parameters gets the same results, order and totals as before.
sortField=5 (TotalRent) sorts properties by the rent for the requested stay, before paging. sortDirection sets the order. A property without a rent for every night of the stay sorts last in both directions. The sort leaves out fees and taxes, and can trail a rate change briefly. Previously, no sort used the requested stay. NightlyRateMin and NightlyRateMax still sort by each property's lowest or highest nightly rate.
GET v1/properties/searchandquote?arrival=2026-12-18&departure=2026-12-22&adults=4&children=1&pets=1&sortField=5
The API reference now names each sortField and sortDirection value next to its number, and describes listingSiteId as the listing site the quote prices for. Previously, it listed only the numbers and described listingSiteId as a filter.
Bug fixes
Inquiries
GET v2/inquiriesreturns no inquiries when none of the ids inproperty_idsbelong to your account. Previously, it returned every inquiry in the account.
OpenAPI specification
- The published specifications at
/openapi/v1.jsonand/openapi/v2.jsonaccept every field of a model that extends a base model, such asidandentity_idtogether onTagModel. Previously, validating such a model against the specification rejected valid fields. - The v2 specification declares a description for every endpoint group, such as Bookings and Tags. Both specifications list the groups in name order with OAuth last. Previously, the v2 specification did not declare its groups.
[Changes effective November 18, 2026]
Add or release a quote's date hold after the quote is created
PATCH /v2/quotes/{id} now honors hold_dates. Previously, it ignored hold_dates, so a quote could hold its dates only when it was created.
"hold_dates": trueadds aquote_holdon the quote's dates, after the request's own date changes."hold_dates": falsedeletes the quote's hold.- With
"test": true,hold_datesis ignored, as it is on create.
GET /v2/quotes and GET /v2/quotes/{id} now return hold_dates.
Cursor paging on spot rates
GET /v2/spotrates now returns rows ordered by property ID, then date. When more rows remain, next_page_url is a link which includes cursor and limit. Following it returns the rows after the last property and date of the previous page. The offset parameter previously on next_page_url is no longer present.
GET /v2/spotrates?property_ids=123&limit=100
{ "items": [ ... ], "next_page_url": "/v2/spotrates?property_ids=123&limit=100&cursor=eyJ…" }
Changed nights on the calendar
GET /v2/calendar and GET /v2/calendar/{property_id} accept an optional since_utc. With it, a night comes back only when it was written at or after one minute before since_utc, inside from and to.
GET /v2/calendar?property_ids=123&since_utc=2026-11-18T15:00:00Z
Bug fixes
Permission errors
- A request for a record in another account returns
403withpermission_deniedand only the permission message, such as "You do not have permission to view this guest.", whatever the state of that account. A request for a record in your own locked or closed account still returnsaccount_lockedoraccount_closed.
Timestamp parameters
- A malformed timestamp, such as
since_utc=bananaonGET /v2/bookings, now returns400with an indication of which parameter was incorrect.
Surcharges and discounts
POST /v2/surchargesandPOST /v2/discountsnow correctly savefalseforactive,is_taxableandauto_generate_description, and save theexpense_amountsent.PATCH /v2/surcharges/{id}andPATCH /v2/discounts/{id}now acceptis_expense_pre_deduct_pm, and save nested values such ascommission.owner_percentandincrement.group_size.- A surcharge or discount read from
GET /v2/surchargesorGET /v2/discounts, withid,created_utcandupdated_utcremoved, is accepted byPOSTandPATCH. Discounts and rate adjustments acceptcategoryrent, andPATCHrefusestypeonly when it differs from the stored type. - A create without
descriptiontakes the type's name for a standard type, such as "Length of Stay". Acomplexcreate without one, and any create with a blank one, returns400. - Criteria that select booking types save, and a booking-type criterion's
valuesread and save asguestorowner. A body that holds a value from an earlierGET, such asEntityCriteriaBookingType.Guest, is still accepted. type,mode,expense_date_typeandcommission.calculationaccept only their own options, by name or by number, and return400otherwise.- A standard discount with no tiers returns
400. - Refusals name each field, operator and value as request bodies spell them, such as
equal_toandarrival_month_of_year.
Fields
POST /v2/fieldsrefusesentity_type2(Address), which fields do not support, with400.POST /v2/fieldsandPATCH /v2/fields/{id}return400for a file field whose value is the ID of a file in another account, and say that the file is not available for this account.
Guests
POST /v2/guestsandPATCH /v2/guests/{id}return400for anullinsidephones,email_addressesoraddresses.
Messages
POST /v2/messagesrefuses each message that Inbox refuses, with400,validation_failedand Inbox's message. This covers a message with no text and no attachment ("Message content is required."), an SMS over 1600 characters, and a WhatsApp message on a thread whose phone number is no longer connected or to the business's own number.POST /v2/messagesrefuses a text to a guest who has opted out of transactional SMS, with a message that names the number, such as "+1 202-555-0102 has opted out of transactional SMS." A reply still sends when the guest texted on that thread within the last 24 hours.POST /v2/messagestrims leading and trailing spaces from the message text, and removes the thread's unedited Rezzy drafts after the send, as Inbox does. Drafts that a team member wrote or edited stay.POST /v2/messagesreturns400whenattachment_urlresponds without an imageContent-Type("attachment_url must return an image Content-Type."), or with a body over 5 MiB, whether or not the response sendsContent-Length.
Spot rates
PATCH /v2/spotratesreturns400for anullrow, naming its index, and for anamountbelow1or amin_nightsormax_nightsbelow1or above65535.
Webhook subscriptions
POST /v2/webhooksubscriptionsreturns400for atypethat holds no supported entity type, such as256, and for an unsupportedaction, such as255.
Webhooks
- Quote webhooks include
charges, and property webhooks includerules, asGETreturns them for the same record. Guest webhooks still leave out phones, email addresses and addresses, and message webhooks still leave outattachment_urls.
API reference
- Every model on the reference pages lists the fields it inherits, such as
idon every model andcriteriaon the discount pages. - A read-only field's description starts with "Read-only. Leave it out of request bodies.", and request examples on the markdown operation pages leave read-only fields out.
- The surcharge and discount criteria
fieldlists the fields each surcharge type accepts, with each field's operators and value, and the criteria example uses a field and operator that the types accept.