messagingRules tools · Foyer Connect

`messagingRules.createRule`

writes

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
`triggerOffsetMinutes`	integer	yes
`sendAtTime`	string · nullable	no
`sendAtDayOffset`	integer	no
`channel`	enum	no	One of: email, whatsapp, sms, auto
`sendEmailCopy`	boolean	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

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
`triggerOffsetMinutes`	integer	yes
`sendAtTime`	string · nullable	yes
`sendAtDayOffset`	integer	yes
`channel`	enum	yes	One of: email, whatsapp, sms, auto
`sendEmailCopy`	boolean	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
`sentCount`	integer	yes
`lastSentAt`	string · nullable	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`messagingRules.deleteCode`

writesconfirm

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`

writesconfirm

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`

read-only

Messaging rules: get rule. Read-only query. See the input schema for argument details.

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
`triggerOffsetMinutes`	integer	yes
`sendAtTime`	string · nullable	yes
`sendAtDayOffset`	integer	yes
`channel`	enum	yes	One of: email, whatsapp, sms, auto
`sendEmailCopy`	boolean	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
`sentCount`	integer	yes
`lastSentAt`	string · nullable	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`messagingRules.listCodes`

read-only

Messaging rules: list codes. Read-only query. See the input schema for argument details.

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
`conditionValue`	object	yes
`properties`	array of string	yes
`platforms`	array of string	yes
`usageCount`	integer	yes
`createdAt`	string	yes
`updatedAt`	string	yes

`messagingRules.retryQueueItem`

writes

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`

writes

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
`triggerOffsetMinutes`	integer	no
`sendAtTime`	string · nullable	no
`sendAtDayOffset`	integer	no
`channel`	enum	no	One of: email, whatsapp, sms, auto
`sendEmailCopy`	boolean	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

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
`triggerOffsetMinutes`	integer	yes
`sendAtTime`	string · nullable	yes
`sendAtDayOffset`	integer	yes
`channel`	enum	yes	One of: email, whatsapp, sms, auto
`sendEmailCopy`	boolean	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
`sentCount`	integer	yes
`lastSentAt`	string · nullable	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`messagingRules.upsertCode`

writes

Messaging rules: upsert code. Mutation — changes data. See the input schema for argument details.

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
`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
`conditionValue`	object	yes
`properties`	array of string	yes
`platforms`	array of string	yes
`usageCount`	integer	yes
`createdAt`	string	yes
`updatedAt`	string	yes