messaging_rules.cancel_queue_item
Cancel a PENDING scheduled guest message so it is never sent. Fails if it is no longer pending. Requires confirmation.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
reason | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
status | string | yes |
messaging_rules.edit_queue_item
Edit a PENDING scheduled guest message before it is sent — override its subject, body, and/or scheduled time. Fails if the message is no longer pending. Requires confirmation.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
renderedSubject | string | no | |
renderedBody | string | no | |
scheduledFor | string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
status | string | yes |
messaging_rules.list_queue
List scheduled + already-sent automatic guest messages across all stays (the queue), newest first, optionally filtered by status (pending|sent|skipped|failed|cancelled). Each item carries the rule name, stay + room, scheduled time, channel, rendered subject, and outcome. Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
status | enum | no | One of: pending, sent, skipped, failed, cancelled |
limit | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.ruleName | string · nullable | yes | |
items.stayId | string | yes | |
items.stayRoom | string · nullable | yes | |
items.scheduledFor | string | yes | |
items.status | string | yes | |
items.channel | string · nullable | yes | |
items.renderedSubject | string · nullable | yes | |
items.sentAt | string · nullable | yes | |
items.failureReason | string · nullable | yes |
messaging_rules.list_rules
List the tenant's automatic guest-message rules: name, whether enabled, priority, the trigger (reference event + offset in minutes), and the channel. Read-only.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.name | string | yes | |
items.description | string · nullable | yes | |
items.enabled | boolean | yes | |
items.priority | number | yes | |
items.triggerReference | string | yes | |
items.triggerOffsetMinutes | number | yes | |
items.channel | string | yes |
messaging_rules.resend_queue_item
Re-send an already-processed scheduled guest message (sent|failed|cancelled): clones it to a fresh PENDING row (new instance key, scheduled now) which the sender re-renders from the current rule + stay and dispatches. Bypasses idempotency; the original history row is kept. Requires confirmation.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
status | string | yes |
messaging_rules.scheduled_for_stay
List the automatic guest messages scheduled for (and already sent to) one stay, ordered chronologically. Read-only. Each item carries the rule name, channel, scheduled time, status (pending|sent|skipped|failed|cancelled), rendered subject/body, and — when applicable — sent time and failure reason.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of object | yes | |
items.id | string | yes | |
items.ruleName | string · nullable | yes | |
items.scheduledFor | string | yes | |
items.status | string | yes | |
items.channel | string · nullable | yes | |
items.renderedSubject | string · nullable | yes | |
items.renderedBody | string · nullable | yes | |
items.sentAt | string · nullable | yes | |
items.failureReason | string · nullable | yes |
messaging_rules.seed_pre_arrival_defaults
Idempotent seed: creates the 'Pre-Arrival Portal' messaging rule for the current tenant if no rule with triggerReference=check_in and a negative offset exists yet. The rule sends guests a portal link by email 48 hours before arrival (−2880 min offset) with German and English templates containing the %checkin_url% placeholder. Returns { seeded: true } when created, { seeded: false, reason: 'already_exists' } when skipped.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
seeded | boolean | yes | |
reason | string | no | Only present when seeded=false. |