---
updatedAt: 2025-09-24T17:45:17.000Z
agentTools:
  projectIndex: https://developers.intandem.tech/llms.txt
---

# The StaffNotification Object

An instance of a notification sent to a staff member, including delivery content and statuses.

## Properties

| Name                               | Description                                                                                                                                          | Type                                                                               | Required |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -------- |
| uid                                | The unique identifier of the staff notification.                                                                                                     | string                                                                             | Yes      |
| staff\_uid                         | The unique identifier of the staff member associated with this notification.                                                                         | string                                                                             | Yes      |
| notification\_template\_code\_name | The code name identifying the notification template to be used.                                                                                      | string                                                                             | Yes      |
| locale                             | The language locale for the notification content.                                                                                                    | string (enum: `en`, `fr`, `de`, `it`, `pl`, `pt`, `es`, `nl`, `he`, `sl`, `en_gb`) | Yes      |
| params                             | Additional parameters for populating notification templates.                                                                                         | array of objects                                                                   |          |
| staff\_portal\_content             | Settings for pane notifications                                                                                                                      | object                                                                             |          |
| email\_content                     | Settings for email notifications                                                                                                                     | object                                                                             |          |
| push\_status                       | The current delivery status of the push notification.                                                                                                | string (enum: `sent`, `failed`)                                                    |          |
| pane\_status                       | The current delivery status of the pane notification.                                                                                                | string (enum: `sent`, `read`, `failed`)                                            |          |
| email\_status                      | History of delivery statuses for the email notification. Each entry represents a status the notification has passed through, in chronological order. | array of strings                                                                   |          |
| created\_at                        | The date and time when the staff notification was created, in ISO 8601 format.                                                                       | string                                                                             | Yes      |
| updated\_at                        | The date and time when the staff notification was last updated, in ISO 8601 format.                                                                  | string                                                                             | Yes      |

### Staff Portal Content Properties

| Name          | Description                                     | Type   | Required |
| ------------- | ----------------------------------------------- | ------ | -------- |
| title         | Title for the notification.                     | string | Yes      |
| message\_body | Message body for the notification.              | string | Yes      |
| deep\_link    | Optional deep link URL for notification action. | string |          |

### Email Content Properties

| Name                   | Description                                | Type   | Required |
| ---------------------- | ------------------------------------------ | ------ | -------- |
| subject                | Email subject line.                        | string | Yes      |
| top\_image             | Image at the top of the email.             | object |          |
| main\_title            | Header or introduction text for the email. | string | Yes      |
| main\_text             | Main content of the email.                 | string | Yes      |
| middle\_image          | Image in the middle of the email.          | object |          |
| middle\_text           | Middle content of the email.               | string |          |
| footer\_text           | Footer or closing text for the email.      | string |          |
| primary\_cta\_button   | Call-to-action button details.             | object |          |
| secondary\_cta\_button | Secondary call-to-action button details.   | object |          |

## Example

JSON

```json
{
  "uid": "staff-notification-12345",
  "staff_uid": "staff-67890",
  "notification_template_code_name": "new_appointment_created",
  "locale": "en",
  "params": [
    {
      "key": "client_name",
      "value": "John Doe"
    },
    {
      "key": "appointment_time",
      "value": "2023-05-15T14:30:00Z"
    }
  ],
  "staff_portal_content": {
    "title": "New appointment",
    "message_body": "You have a new appointment",
    "deep_link": "/appointments/12345"
  },
  "email_content": {
    "subject": "Appointment Confirmation",
    "main_title": "Your appointment is confirmed!",
    "main_text": "Thank you for booking with us. Your appointment is scheduled.",
    "footer_text": "If you have questions, contact us anytime."
  },
  "push_status": "sent",
  "pane_status": "read",
  "email_status": [
    "delivered",
    "open"
  ],
  "created_at": "2023-05-10T09:00:00Z",
  "updated_at": "2023-05-10T09:05:00Z"
}
```