Create a broadcast

Creates a new broadcast. When a broadcast is created, it generates individual notifications for relevant users within the project.

Request body

action_urlstring nullable

The URL recipients will be directed to when interacting with the broadcast.

categorystring nullable

The label used to group broadcasts.

contentstring nullable

The body content delivered with the broadcast.

created_atstring date-time

The timestamp when the broadcast was created.

custom_attributesobject nullable

Arbitrary custom data associated with the broadcast.

idstring uuid

The unique id for this broadcast.

titlestring required

The subject or headline that will be shown to recipients.

topicstring nullable

The topic that further classifies the broadcast.

Example request

{
  "action_url": "https://example.com",
  "category": "example",
  "content": "I come from broadcast",
  "custom_attributes": {},
  "id": "d1b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  "overrides": {},
  "recipients": [
    {
      "custom_attributes": {
        "plan": "enterprise",
        "preferred_pronoun": "They",
        "pricing_version": "v10"
      },
      "email": "test@example.com",
      "external_id": "83d987a-83fd034",
      "first_name": "Person",
      "last_name": "Doe",
      "phone_numbers": [
        "+1 5005550001"
      ]
    }
  ],
  "title": "Hello, World!",
  "topic": "example"
}

Response

Created