messagingRules.createRule
Create a new automated messaging rule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
description | string | no | |
enabled | boolean | no | |
priority | integer | no | |
triggerReference | enum | yes | One of: check_in, check_out, booking_created, checkin_vollstaendig |
triggerOffsetMinutes | integer | yes | |
sendAtTime | string · nullable | no | |
sendAtDayOffset | integer | no | |
channel | enum | no | One of: email, whatsapp, sms, auto |
sendEmailCopy | boolean | no | |
whatsappVorlage | object · nullable | no | |
whatsappVorlage.name | string | yes | |
whatsappVorlage.sprache | string | yes | |
whatsappVorlage.parameter | object | yes | |
whatsappVorlage.text | string | no | |
platformFilter | array of string | no | |
messageTranslations | object | no | |
subjectTranslations | object | no | |
conditions | object | no | |
conditions.minNights | integer | no | |
conditions.maxNights | integer | no | |
conditions.minGuests | integer | no | |
conditions.maxGuests | integer | no | |
conditions.bookingWindowDays | integer | no | |
conditions.nurOhneProbleme | boolean | no | |
conditions.nurOhneCheckin | boolean | no | |
conditions.nurOhneBewertung | boolean | no | |
conditions.minVorlaufStunden | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
description | string · nullable | yes | |
enabled | boolean | yes | |
priority | integer | yes | |
triggerReference | enum | yes | One of: check_in, check_out, booking_created, checkin_vollstaendig |
triggerOffsetMinutes | integer | yes | |
sendAtTime | string · nullable | yes | |
sendAtDayOffset | integer | yes | |
channel | enum | yes | One of: email, whatsapp, sms, auto |
sendEmailCopy | boolean | yes | |
whatsappVorlage | object · nullable | yes | |
whatsappVorlage.name | string | yes | |
whatsappVorlage.sprache | string | yes | |
whatsappVorlage.parameter | object | yes | |
platformFilter | array of string | yes | |
messageTranslations | object | yes | |
subjectTranslations | object | yes | |
conditions | object | yes | |
conditions.minNights | number | no | |
conditions.maxNights | number | no | |
conditions.minGuests | number | no | |
conditions.maxGuests | number | no | |
conditions.bookingWindowDays | number | no | |
conditions.nurOhneProbleme | boolean | no | |
conditions.nurOhneCheckin | boolean | no | |
conditions.nurOhneBewertung | boolean | no | |
conditions.minVorlaufStunden | number | no | |
sentCount | integer | yes | |
lastSentAt | string · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
messagingRules.deleteCode
Delete a custom message short-code.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes |
messagingRules.deleteRule
Delete an automated messaging rule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes |
messagingRules.getRule
Returns a messaging rule (id) with trigger, time offset, conditions, channel and template. Operations roles only (owner, staff, reception). Read-only; an unknown id results in NOT_FOUND.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
description | string · nullable | yes | |
enabled | boolean | yes | |
priority | integer | yes | |
triggerReference | enum | yes | One of: check_in, check_out, booking_created, checkin_vollstaendig |
triggerOffsetMinutes | integer | yes | |
sendAtTime | string · nullable | yes | |
sendAtDayOffset | integer | yes | |
channel | enum | yes | One of: email, whatsapp, sms, auto |
sendEmailCopy | boolean | yes | |
whatsappVorlage | object · nullable | yes | |
whatsappVorlage.name | string | yes | |
whatsappVorlage.sprache | string | yes | |
whatsappVorlage.parameter | object | yes | |
platformFilter | array of string | yes | |
messageTranslations | object | yes | |
subjectTranslations | object | yes | |
conditions | object | yes | |
conditions.minNights | number | no | |
conditions.maxNights | number | no | |
conditions.minGuests | number | no | |
conditions.maxGuests | number | no | |
conditions.bookingWindowDays | number | no | |
conditions.nurOhneProbleme | boolean | no | |
conditions.nurOhneCheckin | boolean | no | |
conditions.nurOhneBewertung | boolean | no | |
conditions.minVorlaufStunden | number | no | |
sentCount | integer | yes | |
lastSentAt | string · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
messagingRules.kommendeFuerStay
Messages that are still to come for this stay but fall beyond the 30-day planning window — preview for the activities (`kommendeNachrichten`). Creates nothing. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
stayId | string | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
ruleId | string | yes | |
ruleName | string | yes | |
geplantAm | string | yes | |
einplanungAb | string | yes | |
entfaelltWegen | string · nullable | yes |
messagingRules.listCodes
Lists the property's own placeholder codes (variables inserted into message templates as %name%), sorted by name, with default value, translations and condition. Operations roles only (owner, staff, reception). Read-only.
Input parameters
Returns object.
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
description | string · nullable | yes | |
defaultValue | string | yes | |
valueTranslations | object | yes | |
conditionType | enum | yes | One of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt |
conditionValue | object | yes | |
properties | array of string | yes | |
platforms | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
messagingRules.reactivateQueueItem
Brings a CANCELLED message back into the automation: it becomes `pending` again and goes out at its originally planned time (if that time has already passed, on the next run). Unlike "Send again" (`sendQueueItemNow` with `erneut`), this sends nothing immediately. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
ruleId | string | yes | |
stayId | string | yes | |
instanceKey | string | yes | |
scheduledFor | string | yes | |
status | enum | yes | One of: pending, sent, skipped, failed, cancelled |
languageHint | string · nullable | yes | |
renderedSubject | string · nullable | yes | |
renderedBody | string · nullable | yes | |
channel | enum | yes | One of: email, whatsapp, sms, auto |
sentMessageId | string · nullable | yes | |
sentAt | string · nullable | yes | |
failedAt | string · nullable | yes | |
failureReason | string · nullable | yes | |
cancelledAt | string · nullable | yes | |
cancelReason | string · nullable | yes | |
operatorEditedAt | string · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
messagingRules.retryQueueItem
Retry a failed queued outbound message.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
ruleId | string | yes | |
stayId | string | yes | |
instanceKey | string | yes | |
scheduledFor | string | yes | |
status | enum | yes | One of: pending, sent, skipped, failed, cancelled |
languageHint | string · nullable | yes | |
renderedSubject | string · nullable | yes | |
renderedBody | string · nullable | yes | |
channel | enum | yes | One of: email, whatsapp, sms, auto |
sentMessageId | string · nullable | yes | |
sentAt | string · nullable | yes | |
failedAt | string · nullable | yes | |
failureReason | string · nullable | yes | |
cancelledAt | string · nullable | yes | |
cancelReason | string · nullable | yes | |
operatorEditedAt | string · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
messagingRules.updateRule
Edit an existing automated messaging rule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
name | string | no | |
description | string | no | |
enabled | boolean | no | |
priority | integer | no | |
triggerReference | enum | no | One of: check_in, check_out, booking_created, checkin_vollstaendig |
triggerOffsetMinutes | integer | no | |
sendAtTime | string · nullable | no | |
sendAtDayOffset | integer | no | |
channel | enum | no | One of: email, whatsapp, sms, auto |
sendEmailCopy | boolean | no | |
whatsappVorlage | object · nullable | no | |
whatsappVorlage.name | string | yes | |
whatsappVorlage.sprache | string | yes | |
whatsappVorlage.parameter | object | yes | |
whatsappVorlage.text | string | no | |
platformFilter | array of string | no | |
messageTranslations | object | no | |
subjectTranslations | object | no | |
conditions | object | no | |
conditions.minNights | integer | no | |
conditions.maxNights | integer | no | |
conditions.minGuests | integer | no | |
conditions.maxGuests | integer | no | |
conditions.bookingWindowDays | integer | no | |
conditions.nurOhneProbleme | boolean | no | |
conditions.nurOhneCheckin | boolean | no | |
conditions.nurOhneBewertung | boolean | no | |
conditions.minVorlaufStunden | integer | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
description | string · nullable | yes | |
enabled | boolean | yes | |
priority | integer | yes | |
triggerReference | enum | yes | One of: check_in, check_out, booking_created, checkin_vollstaendig |
triggerOffsetMinutes | integer | yes | |
sendAtTime | string · nullable | yes | |
sendAtDayOffset | integer | yes | |
channel | enum | yes | One of: email, whatsapp, sms, auto |
sendEmailCopy | boolean | yes | |
whatsappVorlage | object · nullable | yes | |
whatsappVorlage.name | string | yes | |
whatsappVorlage.sprache | string | yes | |
whatsappVorlage.parameter | object | yes | |
platformFilter | array of string | yes | |
messageTranslations | object | yes | |
subjectTranslations | object | yes | |
conditions | object | yes | |
conditions.minNights | number | no | |
conditions.maxNights | number | no | |
conditions.minGuests | number | no | |
conditions.maxGuests | number | no | |
conditions.bookingWindowDays | number | no | |
conditions.nurOhneProbleme | boolean | no | |
conditions.nurOhneCheckin | boolean | no | |
conditions.nurOhneBewertung | boolean | no | |
conditions.minVorlaufStunden | number | no | |
sentCount | integer | yes | |
lastSentAt | string · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
messagingRules.upsertCode
Creates or updates a placeholder code for message templates by name (name, defaultValue, optional description, translations, condition, unit and platform filters). Only optional fields that are passed are overwritten. Owner only. Changes data. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
description | string | no | |
defaultValue | string | yes | |
valueTranslations | object | no | |
conditionType | enum | no | One of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt |
conditionValue | object | no | |
properties | array of string | no | |
platforms | array of string | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
description | string · nullable | yes | |
defaultValue | string | yes | |
valueTranslations | object | yes | |
conditionType | enum | yes | One of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt |
conditionValue | object | yes | |
properties | array of string | yes | |
platforms | array of string | yes | |
usageCount | integer | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
messagingRules.whatsappBilanz
WhatsApp delivery over the last 7 or 30 days: how many templates were sent, delivered, undeliverable or skipped, and how many numbers are currently marked ✗ (no WhatsApp). Operations roles only. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
tage | literal | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
tage | integer | yes | |
gesendet | integer | yes | |
zugestellt | integer | yes | |
nichtZustellbar | integer | yes | |
ohneQuittung | integer | yes | |
uebersprungenKeinWhatsapp | integer | yes | |
uebersprungenSonst | integer | yes | |
abgelehnt | integer | yes | |
nummernOhneWhatsapp | integer | yes |