Get Message Rules

Returns the account's message rules: the automated messages Host Tools sends to guests (or by email, SMS or webhook) on events such as a booking, a check-in or a check-out. Requires the messageRules:read scope.

With listingID, returns every rule that applies to that listing: its own (appliesTo listing), those of the listing groups it is in (listingGroup), and those for all listings (allListings). Paused rules are returned with paused: true and send nothing.

The default rules Host Tools offers a new account are only returned once the host has saved or turned them on in Host Tools.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Only the rules that apply to this listing

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json