Page History

...

Code Block

{
  "id": "328AFX343",
  "status": "scheduled",
  "url": "/api/companies/1/broadcasts/328AFX343",
  "name": "Test Broadcast SAT 2",
  "created_by": "user@company.com",
  "created_by_application": "api",
  "send_scheduled_date": "2017-02-16T17:30:00Z",
  "send_schedule": {
    "method": "by_time_zone",
    "field_name": "vibes_timezone",
    "send_date": "2017-02-16",
    "send_time": "17:30",
    "default_time_zone": "US/Central"
  },
  "targeting": {
    "message_template": "Test Broadcast SAT 2 {{ list_name }} Reply HELP for help, STOP to cancel-Msg&data rates may apply",
    "shorten_urls": true,
    "short_url_base": "http://vbs.cm/",
    "source_short_code": "54321",
    "source_lists": [
      "AB1234Z4",
      "LIST12345"
    ],
    "channel": "push",
    "push": {
      "subject": "The message subject",
      "content_subject": "The content subject",
      "content_url": "http://www.vibes.com",
      "inbox_only": true,
      "metadata": "deep-linking metadata"
    },
    "filters": [
      {
        "name": "favorite_sport",
        "selector": "any",
        "value": [
          "football",
          "baseball"
        ]
      },
      {
        "name": "first_name",
        "selector": "starts_with",
        "value": "Steve"
      },
      {
        "name": "recipient_list",
        "selector": "any",
        "value": [
          "1"
        ]
      },
      {
        "name": "participant_list",
        "selector": "any",
        "value": [
          "1"
        ]
      },
      {
        "name": "country",
        "selector": "equals",
        "value": "US"
      },
      {
        "name": "subscription_date",
        "transform": "year",
        "selector": "before",
        "value": [
          "2017"
        ]
      },
      {
        "name": "birthdate",
        "transform": "year",
        "selector": "before",
        "value": [
          "2017"
        ]
      }
    ]
  }
}

Elements

Data Element	Type	Description
id	Integer	Vibes unique identifier for each Broadcast.
status	String	The status of the Broadcast. Examples (always lowercase): scheduled: The Broadcast will be sent at a scheduled time. in_progress: The Broadcast as begun sending. sent: The Broadcast has finished sending. canceled: The Broadcast has been canceled. deleted: The Broadcast was canceled before sending. paused: The Broadcast is waiting for an external action. failed: The Broadcast has failed.
url	String	Unique resource URL for the Acquisition Campaign.
name	String	The descriptive name of the Broadcast message. Example: "First alert message".
created_by	String	The email address of the person who created the Broadcast.
created_by_application	String	The application. Example: null, api.
send_scheduled_date	Timestamp	The date and time the Broadcast is scheduled to be sent.
targeting	Object	The targeting information for the Broadcast. Examples: message_template, channel, short_url_base, source_short_code, source_lists, shorten_urls.
delivery	Timestamp, String	The information about the Broadcast delivery, including recipient_count, send_start_date, and enqueue_completed_date.
created_at	Timestamp	The date this Broadcast was created.
updated_at	Timestamp	The date this Broadcast was last updated.

Versions Compared

Old Version 80

New Version 81

Key

Elements