About Notification Broadcast

What are notification broadcasts?

Notification Broadcast allows Cirro to send emails to several users as a broadcast.

Endpoints

POST https://api.cirro.io/v2/notification_broadcasts

The notification broadcast object

Attributes

Attribute	Type	Description
`id`	`string`	The unique identifier for the Notification Broadcast.
`object`	`string`	The type of the object, in this case, it's 'notification_broadcast'.
`payload`	`string`	The payload of a broadcast.
`recipients`	`array`	Recipients of the broadcast.
`notification_topic_id`	`string`	The associated notification topic.
`templates`	`array`	The associated notification templates.

Example

{
  "id": "1",
  "object": "notification_broadcast",
  "payload": {
    "key": "value"
  },
  "recipients": {
    "user_ids": [
      "1",
      "2"
    ]
  },
  "notification_topic_id": "1",
  "templates": [
    {
      "notification_configuration_id": "1",
      "subject": "New test invitation",
      "body": "Hello {{firstname}}, this is a priority test for {{customer_name}}..."
    }
  ]
}