---
title: "Create campaign"
method: POST
path: "/user/campaign"
tags: ["Campaigns"]
---

# Create campaign

`POST /user/campaign`

## Request

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

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

[Docs](https://docs.famulor.io/api-v1/campaigns/create)

## Request body

- object
  - `name` string, required: Campaign name. Maximum 255 characters.
  - `channel` string: `call`, `whatsapp`, or `sms`.
  - `timezone` string: IANA timezone for the send/call window (e.g. `America/New_York`). Defaults to the assistant timezone for call campaigns, otherwise your account timezone.
  - `schedule_windows` unknown[]: Preferred schedule: one or more daily windows as objects with `start` and `end` in `HH:MM`. Overnight windows are supported when `end` is earlier than `start` (e.g. `16:00` → `02:00`).
    - unknown
  - `allowed_hours_start_time` string: Legacy single-window start (`HH:MM`). Used if `schedule_windows` is omitted.
  - `allowed_hours_end_time` string: Legacy single-window end (`HH:MM`). Overnight when `end` < `start`.
  - `scheduled_start_at` string: Optional ISO datetime. When set, the campaign can be scheduled to auto-start at that time.
  - `allowed_days` unknown[]: Weekdays: `monday` … `sunday`.
    - unknown
  - `max_retries` integer: Max retry attempts per lead. Range: 1–5.
  - `retry_interval` integer: Minutes between retries. Range: 10–4320.
  - `mark_complete_when_no_leads` boolean: Automatically mark the campaign complete when no remaining work is left.
  - `assistant_id` integer: Required for `channel=call`. Must be an OUTBOUND assistant you own.
  - `max_calls_in_parallel` integer: Concurrent calls (plan-bounded, max 10).
  - `phone_number_ids` unknown[]: Outbound from-number IDs available to your account.
    - unknown
  - `retry_on_voicemail` boolean: Retry when a call hits voicemail.
  - `retry_on_goal_incomplete` boolean: Keep retrying until a boolean post-call goal variable is true.
  - `goal_completion_variable` string: Boolean post-call schema variable name used with `retry_on_goal_incomplete`.
  - `fallback_channel` string: Optional call→text follow-up after max call retries: `whatsapp` or `sms`.
  - `fallback_whatsapp_sender_id` integer: Required when `fallback_channel=whatsapp`.
  - `fallback_whatsapp_template_id` integer: Required when `fallback_channel=whatsapp`. Must be an approved template on that sender.
  - `fallback_sms_from_phone_number_id` integer: Required when `fallback_channel=sms`.
  - `fallback_sms_body` string: Required when `fallback_channel=sms`. Supports `{{variable}}` placeholders.
  - `fallback_variable_mapping` object: Maps WhatsApp template placeholders (e.g. `"1"`) to lead variable keys for the fallback send.
  - `whatsapp_sender_id` integer: Required for `channel=whatsapp`. Sender you own.
  - `whatsapp_template_id` integer: Required for `channel=whatsapp`. Approved template on that sender.
  - `text_variable_mapping` object: Maps template placeholders (e.g. `"1"`) to lead variable keys.
  - `messages_per_minute` integer: 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_id` integer: Required for `channel=sms`. Must be SMS-capable and available to you.
  - `sms_body` string: Required for `channel=sms`. Max 1600 characters. Supports `{{variable}}` placeholders.

## Response `201`

Created

- object
  - `message` string: Success message
  - `data` object: Created campaign (same shape as [Get campaign](/en/api-reference/campaigns/get)), including channel, schedule, text config, and fallback fields.
  - `422 Unprocessable Entity` string: Plan limit, invalid assistant/sender/template, disabled channel, or validation errors.

## Other responses

- `401`: Fehlender oder ungültiger API-Key.
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/famulor/apis/famulor-api.md) · [All operations](https://skmtc.dev/famulor/apis/famulor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/famulor/apis/famulor-api/revisions/3b938c370721?raw)