ActiveCampaign · JSON Structure

Activecampaign Sms Broadcast Create Request Structure

BroadcastCreateRequest schema from ActiveCampaign API

Type: object Properties: 13 Required: 2
Marketing AutomationEmail MarketingCRMSales AutomationCustomer Experience

BroadcastCreateRequest is a JSON Structure definition published by ActiveCampaign, describing 13 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name address_id body media_urls preview_url shorten_track_links_enabled status scheduled_date sent_to_count list_ids segment_id custom_segment_id label_ids

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-broadcast-create-request-structure.json",
  "name": "BroadcastCreateRequest",
  "description": "BroadcastCreateRequest schema from ActiveCampaign API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the broadcast"
    },
    "address_id": {
      "type": "int32",
      "nullable": true,
      "description": "ID for sender name"
    },
    "body": {
      "type": "string",
      "description": "SMS message content"
    },
    "media_urls": {
      "type": "array",
      "items": {
        "type": "uri"
      },
      "description": "Media URLs for MMS"
    },
    "preview_url": {
      "type": "uri"
    },
    "shorten_track_links_enabled": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft"
      ]
    },
    "scheduled_date": {
      "type": "datetime"
    },
    "sent_to_count": {
      "type": "int32"
    },
    "list_ids": {
      "type": "array",
      "items": {
        "type": "int32"
      }
    },
    "segment_id": {
      "type": "string"
    },
    "custom_segment_id": {
      "type": "uuid",
      "description": "custom segment id generated from segmentsV2 endpoint and passing in a valid audience",
      "nullable": true
    },
    "label_ids": {
      "type": "array",
      "items": {
        "type": "int32"
      }
    }
  },
  "required": [
    "name",
    "body"
  ]
}