Skip to main content

Create a new campaign

POST 
/api/communication/campaigns/

Create a campaign for the authenticated user's entity.

Required Fields​

  • status → ID of a valid Status record (Scheduled or Draft).
  • channel → SMS, Email, WhatsApp, Telegram, Voice, All.
  • campaign_name → Name of this campaign.
  • sender_name → CampaignSender ID.
  • target_audience → TargetMarket ID.
  • body → Message body content.

Optional Fields​

  • subject_line → For email / voice style channels.
  • send_date + send_time → Used if the campaign is scheduled.
  • attachments → Optional files to be associated with the campaign.

Response​

Returns the full created campaign with expanded nested details:

  • status_detail
  • sender_detail
  • audience_detail

Notes​

  • Entity is automatically attached based on the authenticated user.
  • After creation, messages are automatically prepared using prepare_messages_for_campaign.

Request​

Responses​