ActiveCampaign · JSON Structure

Activecampaign Sms Broadcast Message Structure

BroadcastMessage schema from ActiveCampaign API

Type: object Properties: 25

Marketing AutomationEmail MarketingCRMSales AutomationCustomer Experience

BroadcastMessage is a JSON Structure definition published by ActiveCampaign, describing 25 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name address_id body media_urls preview_url shorten_track_links_enabled status sent_date scheduled_date custom_run_id custom_segment_id scheduled_by sent_to_count created_at created_by updated_at updated_by deleted_at sift_approved arc_approved quiet_hours_enabled list_ids segment_id label_ids

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-broadcast-message-structure.json",
  "name": "BroadcastMessage",
  "description": "BroadcastMessage schema from ActiveCampaign API",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Unique identifier for the broadcast"
    },
    "name": {
      "type": "string",
      "description": "Name of the broadcast"
    },
    "address_id": {
      "type": "int32",
      "nullable": true,
      "description": "ID used to get sender name"
    },
    "body": {
      "type": "string",
      "description": "SMS message content"
    },
    "media_urls": {
      "type": "array",
      "items": {
        "type": "uri"
      },
      "description": "Media URLs for MMS messages"
    },
    "preview_url": {
      "type": "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": "datetime",
      "nullable": true,
      "description": "Date when broadcast was sent"
    },
    "scheduled_date": {
      "type": "datetime",
      "nullable": true,
      "description": "Scheduled send date (UTC)"
    },
    "custom_run_id": {
      "type": "uuid",
      "nullable": true,
      "description": "custom run id generated from segmentMatchSome endpoint"
    },
    "custom_segment_id": {
      "type": "uuid",
      "nullable": true,
      "description": "custom segment id generated from segmentsV2 endpoint and passing in a valid audience"
    },
    "scheduled_by": {
      "type": "int32",
      "nullable": true,
      "description": "User ID who scheduled the broadcast"
    },
    "sent_to_count": {
      "type": "int32",
      "nullable": true,
      "description": "Number of recipients"
    },
    "created_at": {
      "type": "datetime",
      "description": "Creation timestamp"
    },
    "created_by": {
      "type": "int32",
      "description": "User ID who created the broadcast"
    },
    "updated_at": {
      "type": "datetime",
      "description": "Last update timestamp"
    },
    "updated_by": {
      "type": "int32",
      "description": "User ID who last updated"
    },
    "deleted_at": {
      "type": "datetime",
      "nullable": true,
      "description": "Deletion timestamp (for soft deletes)"
    },
    "sift_approved": {
      "type": "int32",
      "description": "Sift approval status"
    },
    "arc_approved": {
      "type": "int32",
      "description": "ARC approval status"
    },
    "quiet_hours_enabled": {
      "type": "int32",
      "nullable": true,
      "description": "Whether quiet hours are enabled"
    },
    "list_ids": {
      "type": "array",
      "items": {
        "type": "int32"
      },
      "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": "int32"
      },
      "nullable": true,
      "description": "Associated label IDs"
    }
  }
}