Recipient Object


Properties
idstringRead-onlyformat GUID

Recipient ID.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient.

Ignored when creating a Recipient.


createdDatestringRead-onlyformat date-time

Date and time the Recipient was created.


updatedDatestringRead-onlyformat date-time

Date and time the Recipient was last updated.


phonestringformat PHONE

Recipient's phone number for receiving notifications.


businessLocationIdsArray <string>minItems 0maxItems 100format GUID

IDs of the business locations this recipient should receive order creation notifications for.

If this list is empty the recipient receives notifications for orders created at all locations.


channelsArray <string>minItems 1maxItems 2

Communication channels for sending notifications to the recipient.

At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously.


notestringmaxLength 500

Additional information about the recipient.

Use this field to store notes about the recipient's role, availability, or other relevant details for notification management.


extendedFieldsExtendedFields

Additional custom fields for the recipient.


tagsTags

Tags for categorizing and organizing recipients.

Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications.

Did this help?