BroadcastCreateRequest

BroadcastCreateRequest schema from ActiveCampaign API

Marketing AutomationEmail MarketingCRMSales AutomationCustomer Experience

Properties

Name	Type	Description
name	string	Name of the broadcast
address_id	integer	ID for sender name
body	string	SMS message content
media_urls	array	Media URLs for MMS
preview_url	string
shorten_track_links_enabled	boolean
status	string
scheduled_date	string
sent_to_count	integer
list_ids	array
segment_id	string
custom_segment_id	string	custom segment id generated from segmentsV2 endpoint and passing in a valid audience
label_ids	array

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-create-request-schema.json",
  "title": "BroadcastCreateRequest",
  "description": "BroadcastCreateRequest schema from ActiveCampaign API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the broadcast"
    },
    "address_id": {
      "type": "integer",
      "nullable": true,
      "description": "ID for sender name"
    },
    "body": {
      "type": "string",
      "description": "SMS message content"
    },
    "media_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Media URLs for MMS"
    },
    "preview_url": {
      "type": "string",
      "format": "uri"
    },
    "shorten_track_links_enabled": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft"
      ]
    },
    "scheduled_date": {
      "type": "string",
      "format": "date-time"
    },
    "sent_to_count": {
      "type": "integer"
    },
    "list_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "segment_id": {
      "type": "string"
    },
    "custom_segment_id": {
      "type": "string",
      "description": "custom segment id generated from segmentsV2 endpoint and passing in a valid audience",
      "format": "uuid",
      "nullable": true
    },
    "label_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "required": [
    "name",
    "body"
  ]
}