BroadcastMessage

BroadcastMessage schema from ActiveCampaign API

Marketing AutomationEmail MarketingCRMSales AutomationCustomer Experience

Properties

Name	Type	Description
id	integer	Unique identifier for the broadcast
name	string	Name of the broadcast
address_id	integer	ID used to get sender name
body	string	SMS message content
media_urls	array	Media URLs for MMS messages
preview_url	string	URL for message preview
shorten_track_links_enabled	boolean	Whether link shortening is enabled
status	string	Current status of the broadcast
sent_date	string	Date when broadcast was sent
scheduled_date	string	Scheduled send date (UTC)
custom_run_id	string	custom run id generated from segmentMatchSome endpoint
custom_segment_id	string	custom segment id generated from segmentsV2 endpoint and passing in a valid audience
scheduled_by	integer	User ID who scheduled the broadcast
sent_to_count	integer	Number of recipients
created_at	string	Creation timestamp
created_by	integer	User ID who created the broadcast
updated_at	string	Last update timestamp
updated_by	integer	User ID who last updated
deleted_at	string	Deletion timestamp (for soft deletes)
sift_approved	integer	Sift approval status
arc_approved	integer	ARC approval status
quiet_hours_enabled	integer	Whether quiet hours are enabled
list_ids	array	Associated list IDs
segment_id	string	Segment ID (can be UUID or integer string)
label_ids	array	Associated label IDs

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-message-schema.json",
  "title": "BroadcastMessage",
  "description": "BroadcastMessage schema from ActiveCampaign API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the broadcast"
    },
    "name": {
      "type": "string",
      "description": "Name of the broadcast"
    },
    "address_id": {
      "type": "integer",
      "nullable": true,
      "description": "ID used to get sender name"
    },
    "body": {
      "type": "string",
      "description": "SMS message content"
    },
    "media_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Media URLs for MMS messages"
    },
    "preview_url": {
      "type": "string",
      "format": "uri",
      "description": "URL for message preview"
    },
    "shorten_track_links_enabled": {
      "type": "boolean",
      "description": "Whether link shortening is enabled"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "scheduled",
        "sent",
        "pending_review",
        "sending"
      ],
      "description": "Current status of the broadcast"
    },
    "sent_date": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Date when broadcast was sent"
    },
    "scheduled_date": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Scheduled send date (UTC)"
    },
    "custom_run_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "custom run id generated from segmentMatchSome endpoint"
    },
    "custom_segment_id": {
      "type": "string",
      "format": "uuid",
      "nullable": true,
      "description": "custom segment id generated from segmentsV2 endpoint and passing in a valid audience"
    },
    "scheduled_by": {
      "type": "integer",
      "nullable": true,
      "description": "User ID who scheduled the broadcast"
    },
    "sent_to_count": {
      "type": "integer",
      "nullable": true,
      "description": "Number of recipients"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Creation timestamp"
    },
    "created_by": {
      "type": "integer",
      "description": "User ID who created the broadcast"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last update timestamp"
    },
    "updated_by": {
      "type": "integer",
      "description": "User ID who last updated"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Deletion timestamp (for soft deletes)"
    },
    "sift_approved": {
      "type": "integer",
      "description": "Sift approval status"
    },
    "arc_approved": {
      "type": "integer",
      "description": "ARC approval status"
    },
    "quiet_hours_enabled": {
      "type": "integer",
      "nullable": true,
      "description": "Whether quiet hours are enabled"
    },
    "list_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Associated list IDs"
    },
    "segment_id": {
      "type": "string",
      "nullable": true,
      "description": "Segment ID (can be UUID or integer string)"
    },
    "label_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "nullable": true,
      "description": "Associated label IDs"
    }
  }
}