mautic / mautic/developer-documentation-new

Campaign API docs are outdated and do not reflect current graph/import-export capabilities

Open
#322 2 comments 0 reactions 1 assignee View on GitHub

@alexhammerschmied is already working on this.

Since Apr 17, 2026.

documentation
Dominant language
Shell
Stars
19
Forks
48
Avg merge
1d 16h
Merged PRs (30d)
25

Description

The current Campaign API documentation appears to lag behind the codebase and does not adequately describe the current campaign graph model or the operational capabilities already present in Mautic.

Problem

The live page at devdocs.mautic.org already warns that it requires a major update. After reviewing the current Mautic codebase, there appear to be several campaign capabilities that are either under-documented or not surfaced clearly enough for implementers, agencies, and tooling authors.

Examples from current code include:

  • graph-based campaign persistence through CampaignModel::setEvents(...)
  • campaign entities exposing events, lists, forms, canvasSettings, and allowRestart
  • campaign clone support in CampaignApiController
  • campaign import/export support in CampaignApiController
  • event-level APIs and campaign event log/contact-event APIs
  • campaign dependency/export behavior via import/export subscribers

Why this matters

For people building integrations, agency delivery workflows, and agent/MCP tooling, the current docs make campaigns look much simpler than they really are. That creates two problems:

  • people may assume important capabilities do not exist
  • people may reverse-engineer behavior from source instead of relying on stable documentation

Suggested improvements

  1. Update the Campaign API docs to explain the campaign graph model more clearly
  2. Add realistic request/response examples for campaign create/update payloads, especially:
    • events
    • lists
    • forms
    • canvasSettings
  3. Document clone/import/export capabilities and intended use cases
  4. Document event-related APIs and contact-event/log workflows
  5. Clarify any differences or overlap between legacy controller-based API behavior and newer entity/API resource behavior where relevant
  6. Add version/caveat notes where behavior is changing or partially documented

Potential follow-up work

If useful, I’d be happy to help draft or contribute the actual doc updates after alignment on scope.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.