FoyerDevelopers

Generated · Live registry

messagingRules tools

11 tools in this domain, generated from the running registry.

All tool domains

messagingRules.createRule

writes

Create a new automated messaging rule.

Input parameters

FieldTypeRequiredNotes
namestringyes
descriptionstringno
enabledbooleanno
priorityintegerno
triggerReferenceenumyesOne of: check_in, check_out, booking_created, checkin_vollstaendig
triggerOffsetMinutesintegeryes
sendAtTimestring · nullableno
sendAtDayOffsetintegerno
channelenumnoOne of: email, whatsapp, sms, auto
sendEmailCopybooleanno
whatsappVorlageobject · nullableno
whatsappVorlage.namestringyes
whatsappVorlage.sprachestringyes
whatsappVorlage.parameterobjectyes
whatsappVorlage.textstringno
platformFilterarray of stringno
messageTranslationsobjectno
subjectTranslationsobjectno
conditionsobjectno
conditions.minNightsintegerno
conditions.maxNightsintegerno
conditions.minGuestsintegerno
conditions.maxGuestsintegerno
conditions.bookingWindowDaysintegerno
conditions.nurOhneProblemebooleanno
conditions.nurOhneCheckinbooleanno
conditions.nurOhneBewertungbooleanno
conditions.minVorlaufStundenintegerno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
enabledbooleanyes
priorityintegeryes
triggerReferenceenumyesOne of: check_in, check_out, booking_created, checkin_vollstaendig
triggerOffsetMinutesintegeryes
sendAtTimestring · nullableyes
sendAtDayOffsetintegeryes
channelenumyesOne of: email, whatsapp, sms, auto
sendEmailCopybooleanyes
whatsappVorlageobject · nullableyes
whatsappVorlage.namestringyes
whatsappVorlage.sprachestringyes
whatsappVorlage.parameterobjectyes
platformFilterarray of stringyes
messageTranslationsobjectyes
subjectTranslationsobjectyes
conditionsobjectyes
conditions.minNightsnumberno
conditions.maxNightsnumberno
conditions.minGuestsnumberno
conditions.maxGuestsnumberno
conditions.bookingWindowDaysnumberno
conditions.nurOhneProblemebooleanno
conditions.nurOhneCheckinbooleanno
conditions.nurOhneBewertungbooleanno
conditions.minVorlaufStundennumberno
sentCountintegeryes
lastSentAtstring · nullableyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

messagingRules.deleteCode

writesconfirm

Delete a custom message short-code.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

messagingRules.deleteRule

writesconfirm

Delete an automated messaging rule.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

messagingRules.getRule

read-only

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

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
enabledbooleanyes
priorityintegeryes
triggerReferenceenumyesOne of: check_in, check_out, booking_created, checkin_vollstaendig
triggerOffsetMinutesintegeryes
sendAtTimestring · nullableyes
sendAtDayOffsetintegeryes
channelenumyesOne of: email, whatsapp, sms, auto
sendEmailCopybooleanyes
whatsappVorlageobject · nullableyes
whatsappVorlage.namestringyes
whatsappVorlage.sprachestringyes
whatsappVorlage.parameterobjectyes
platformFilterarray of stringyes
messageTranslationsobjectyes
subjectTranslationsobjectyes
conditionsobjectyes
conditions.minNightsnumberno
conditions.maxNightsnumberno
conditions.minGuestsnumberno
conditions.maxGuestsnumberno
conditions.bookingWindowDaysnumberno
conditions.nurOhneProblemebooleanno
conditions.nurOhneCheckinbooleanno
conditions.nurOhneBewertungbooleanno
conditions.minVorlaufStundennumberno
sentCountintegeryes
lastSentAtstring · nullableyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

messagingRules.kommendeFuerStay

read-only

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

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
ruleIdstringyes
ruleNamestringyes
geplantAmstringyes
einplanungAbstringyes
entfaelltWegenstring · nullableyes

messagingRules.listCodes

read-only

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:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
defaultValuestringyes
valueTranslationsobjectyes
conditionTypeenumyesOne of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt
conditionValueobjectyes
propertiesarray of stringyes
platformsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes

messagingRules.reactivateQueueItem

writes

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

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
ruleIdstringyes
stayIdstringyes
instanceKeystringyes
scheduledForstringyes
statusenumyesOne of: pending, sent, skipped, failed, cancelled
languageHintstring · nullableyes
renderedSubjectstring · nullableyes
renderedBodystring · nullableyes
channelenumyesOne of: email, whatsapp, sms, auto
sentMessageIdstring · nullableyes
sentAtstring · nullableyes
failedAtstring · nullableyes
failureReasonstring · nullableyes
cancelledAtstring · nullableyes
cancelReasonstring · nullableyes
operatorEditedAtstring · nullableyes
createdAtstringyes
updatedAtstringyes

messagingRules.retryQueueItem

writes

Retry a failed queued outbound message.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
ruleIdstringyes
stayIdstringyes
instanceKeystringyes
scheduledForstringyes
statusenumyesOne of: pending, sent, skipped, failed, cancelled
languageHintstring · nullableyes
renderedSubjectstring · nullableyes
renderedBodystring · nullableyes
channelenumyesOne of: email, whatsapp, sms, auto
sentMessageIdstring · nullableyes
sentAtstring · nullableyes
failedAtstring · nullableyes
failureReasonstring · nullableyes
cancelledAtstring · nullableyes
cancelReasonstring · nullableyes
operatorEditedAtstring · nullableyes
createdAtstringyes
updatedAtstringyes

messagingRules.updateRule

writes

Edit an existing automated messaging rule.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringno
descriptionstringno
enabledbooleanno
priorityintegerno
triggerReferenceenumnoOne of: check_in, check_out, booking_created, checkin_vollstaendig
triggerOffsetMinutesintegerno
sendAtTimestring · nullableno
sendAtDayOffsetintegerno
channelenumnoOne of: email, whatsapp, sms, auto
sendEmailCopybooleanno
whatsappVorlageobject · nullableno
whatsappVorlage.namestringyes
whatsappVorlage.sprachestringyes
whatsappVorlage.parameterobjectyes
whatsappVorlage.textstringno
platformFilterarray of stringno
messageTranslationsobjectno
subjectTranslationsobjectno
conditionsobjectno
conditions.minNightsintegerno
conditions.maxNightsintegerno
conditions.minGuestsintegerno
conditions.maxGuestsintegerno
conditions.bookingWindowDaysintegerno
conditions.nurOhneProblemebooleanno
conditions.nurOhneCheckinbooleanno
conditions.nurOhneBewertungbooleanno
conditions.minVorlaufStundenintegerno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
enabledbooleanyes
priorityintegeryes
triggerReferenceenumyesOne of: check_in, check_out, booking_created, checkin_vollstaendig
triggerOffsetMinutesintegeryes
sendAtTimestring · nullableyes
sendAtDayOffsetintegeryes
channelenumyesOne of: email, whatsapp, sms, auto
sendEmailCopybooleanyes
whatsappVorlageobject · nullableyes
whatsappVorlage.namestringyes
whatsappVorlage.sprachestringyes
whatsappVorlage.parameterobjectyes
platformFilterarray of stringyes
messageTranslationsobjectyes
subjectTranslationsobjectyes
conditionsobjectyes
conditions.minNightsnumberno
conditions.maxNightsnumberno
conditions.minGuestsnumberno
conditions.maxGuestsnumberno
conditions.bookingWindowDaysnumberno
conditions.nurOhneProblemebooleanno
conditions.nurOhneCheckinbooleanno
conditions.nurOhneBewertungbooleanno
conditions.minVorlaufStundennumberno
sentCountintegeryes
lastSentAtstring · nullableyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

messagingRules.upsertCode

writes

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

FieldTypeRequiredNotes
namestringyes
descriptionstringno
defaultValuestringyes
valueTranslationsobjectno
conditionTypeenumnoOne of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt
conditionValueobjectno
propertiesarray of stringno
platformsarray of stringno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
descriptionstring · nullableyes
defaultValuestringyes
valueTranslationsobjectyes
conditionTypeenumyesOne of: always, nights, property, booking_date, check_in_hours, whatsapp_fehlt
conditionValueobjectyes
propertiesarray of stringyes
platformsarray of stringyes
usageCountintegeryes
createdAtstringyes
updatedAtstringyes

messagingRules.whatsappBilanz

read-only

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

FieldTypeRequiredNotes
tageliteralyes

Output fields

FieldTypeRequiredNotes
tageintegeryes
gesendetintegeryes
zugestelltintegeryes
nichtZustellbarintegeryes
ohneQuittungintegeryes
uebersprungenKeinWhatsappintegeryes
uebersprungenSonstintegeryes
abgelehntintegeryes
nummernOhneWhatsappintegeryes