Campaigns

Create campaign

Create a draft call, WhatsApp, or SMS campaign in Famulor via API. Add leads, then start with Update campaign status.

Docs

post/user/campaign

Request

  • Base URL: https://app.famulor.de/api
  • URL: https://app.famulor.de/api/user/campaign
  • Auth: HTTP bearer

Request body

namestring required

Campaign name. Maximum 255 characters.

channelstring

call, whatsapp, or sms.

timezonestring

IANA timezone for the send/call window (e.g. America/New_York). Defaults to the assistant timezone for call campaigns, otherwise your account timezone.

allowed_hours_start_timestring

Legacy single-window start (HH:MM). Used if schedule_windows is omitted.

allowed_hours_end_timestring

Legacy single-window end (HH:MM). Overnight when end < start.

scheduled_start_atstring

Optional ISO datetime. When set, the campaign can be scheduled to auto-start at that time.

max_retriesinteger

Max retry attempts per lead. Range: 1–5.

retry_intervalinteger

Minutes between retries. Range: 10–4320.

mark_complete_when_no_leadsboolean

Automatically mark the campaign complete when no remaining work is left.

assistant_idinteger

Required for channel=call. Must be an OUTBOUND assistant you own.

max_calls_in_parallelinteger

Concurrent calls (plan-bounded, max 10).

retry_on_voicemailboolean

Retry when a call hits voicemail.

retry_on_goal_incompleteboolean

Keep retrying until a boolean post-call goal variable is true.

goal_completion_variablestring

Boolean post-call schema variable name used with retry_on_goal_incomplete.

fallback_channelstring

Optional call→text follow-up after max call retries: whatsapp or sms.

fallback_whatsapp_sender_idinteger

Required when fallback_channel=whatsapp.

fallback_whatsapp_template_idinteger

Required when fallback_channel=whatsapp. Must be an approved template on that sender.

fallback_sms_from_phone_number_idinteger

Required when fallback_channel=sms.

fallback_sms_bodystring

Required when fallback_channel=sms. Supports {{variable}} placeholders.

fallback_variable_mappingobject

Maps WhatsApp template placeholders (e.g. "1") to lead variable keys for the fallback send.

whatsapp_sender_idinteger

Required for channel=whatsapp. Sender you own.

whatsapp_template_idinteger

Required for channel=whatsapp. Approved template on that sender.

text_variable_mappingobject

Maps template placeholders (e.g. "1") to lead variable keys.

messages_per_minuteinteger

Per-campaign send rate (1–10). WhatsApp campaigns also share a user-wide pool of 10 in-flight sends across all your active WhatsApp campaigns.

sms_from_phone_number_idinteger

Required for channel=sms. Must be SMS-capable and available to you.

sms_bodystring

Required for channel=sms. Max 1600 characters. Supports {{variable}} placeholders.

Response

Created

messagestring

Success message

dataobject

Created campaign (same shape as Get campaign), including channel, schedule, text config, and fallback fields.

422 Unprocessable Entitystring

Plan limit, invalid assistant/sender/template, disabled channel, or validation errors.

Changes

No recorded changes to this operation across all 1 revision of this API.