Email and text campaigns

{
  "limit": 5
}

{
  "business": "Example Service Group",
  "timezone": "America/New_York",
  "channels": {
    "email": {
      "available": true
    },
    "sms": {
      "available": true,
      "sending_numbers": [
        {
          "id": "77777777-7777-4777-8777-777777777777",
          "number": "+19195550142",
          "default": true,
          "status": "active",
          "campaign": "Summer tune-ups"
        }
      ],
      "send_window": "Weekdays 9:00 to 17:00, local time",
      "promotional_cap": {
        "used": 1,
        "cap": 4,
        "window_days": 30
      }
    }
  },
  "from": {
    "name": "Example Service Group",
    "email": "info@mail.esg.example",
    "reply_to": "hello@esg.example"
  },
  "consent": {
    "contacts": 1280,
    "email_consented": 1034,
    "sms_promotional_consented": 412,
    "opted_out": {
      "sms": 9,
      "email": 21
    }
  },
  "segments": [
    {
      "id": "55555555-5555-4555-8555-555555555555",
      "name": "Maintenance members",
      "type": "static",
      "contacts": 318
    }
  ],
  "data": {
    "recent_campaigns": [
      {
        "id": "44444444-4444-4444-8444-444444444444",
        "name": "Summer tune-ups",
        "status": "sent",
        "channels": [
          "email"
        ],
        "scheduled_for": null,
        "sent_at": "2026-09-01T14:00:00.000Z",
        "stats": {
          "total_sent": 409,
          "total_failed": 3,
          "email_sent": 409,
          "email_delivered": 401
        },
        "results": {
          "email": {
            "sent": "409",
            "delivered": "401",
            "opened": "n/a",
            "clicked": "n/a",
            "replied": "n/a",
            "opt_outs": "n/a"
          },
          "caveats": []
        }
      }
    ],
    "results_caveats": [
      "Open and click tracking is off to protect deliverability, so opened and clicked show n/a."
    ]
  }
}

{}

{
  "business": {
    "name": "Example Service Group",
    "address": "12 Main St, Raleigh, NC 27601",
    "website": "https://esg.example"
  },
  "from": {
    "name": "Example Service Group",
    "email": "info@mail.esg.example",
    "reply_to": "hello@esg.example"
  },
  "phone": {
    "display": {
      "variable": "{{company_phone}}",
      "resolves_to": "(919) 555-0142"
    },
    "tel_links": {
      "variable": "{{company_phone_tracking}}",
      "resolves_to": "(919) 555-9999"
    },
    "rule": "Show the number with the display variable. Every tel: href must use the tracking variable, or the call is not credited to this email. A number typed into the HTML is refused."
  },
  "greeting": {
    "variable": "{{first_name}}",
    "rule": "Put the greeting in its own paragraph, for example <p>Hi {{first_name}},</p>."
  },
  "logo": {
    "light_background": {
      "variable": "{{company_logo_light}}",
      "resolves_to": "https://cdn.esg.example/logo.png"
    },
    "dark_background": {
      "variable": "{{company_logo_dark}}",
      "resolves_to": null
    }
  },
  "theme": {
    "brand": "#0b5d3b",
    "brandInk": "#e8c547",
    "accent": "#f59e0b",
    "accentInk": "#111827",
    "ink": "#111827",
    "ink70": "#585d68",
    "inkFaint": "#94979e",
    "surface": "#ffffff",
    "surfaceAlt": "#f5f6f6",
    "hairline": "#e2e3e5",
    "cta": "#f59e0b",
    "ctaInk": "#111827",
    "kickerColor": "#f59e0b",
    "danger": "#ef4444",
    "warning": "#f59e0b",
    "radius": 8,
    "radiusControl": 8,
    "radiusCard": 8,
    "elevation": "hairline",
    "headingWeight": 700,
    "headingTracking": "normal",
    "radiusCss": "8px",
    "radiusControlCss": "8px",
    "radiusCardCss": "8px",
    "arcsize": "32%",
    "headingFontStack": "'Inter',-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif",
    "bodyFontStack": "'Inter',-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,'Helvetica Neue',Arial,sans-serif",
    "webFontImport": "<link href=\"https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap\" rel=\"stylesheet\">",
    "rules": "Brand, accent, and kicker colors are TEXT colors, never backgrounds."
  },
  "design": {
    "language": "ledger",
    "rules": [
      "One continuous bordered card; every section is a row inside it.",
      "Keep the version marker <!-- tmg-email:ledger-v1 --> exactly once, right after <body>."
    ],
    "scaffold": "<!DOCTYPE html><html><body><!-- tmg-email:ledger-v1 --><table role=\"presentation\">...</table></body></html>"
  },
  "call_to_action": {
    "url": "https://esg.example/contact",
    "alternatives": {
      "website": "https://esg.example",
      "call": "tel:{{company_phone_tracking}}"
    }
  },
  "images": {
    "rule": "Only your own library. Call list_media, then use media://<media_id> as the img src."
  },
  "unsubscribe": {
    "rule": "Do not write one. The required footer is appended to every marketing email at send time."
  },
  "next_step": "Draft from the scaffold, then preview_email."
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444"
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "status": "sent",
  "sent_at": "2026-09-01T14:00:00.000Z",
  "data": {
    "name": "Summer tune-ups",
    "email_subject": "{{first_name}}, your summer tune-up is due",
    "email_html": "<html><body><p>Hi {{first_name}},</p><p>Call {{company_phone}}.</p></body></html>"
  },
  "note_on_style": "This campaign predates the current design language. Use it for tone and content only; the layout to follow is the scaffold in get_email_brand_kit."
}

{
  "name": "Fall tune-up",
  "channels": [
    "email"
  ],
  "email_subject": "Fall tune-up time",
  "email_html": "<p>Book your tune-up.</p>"
}

{
  "campaign": {
    "id": "44444444-4444-4444-8444-444444444444",
    "name": "Fall tune-up",
    "status": "draft",
    "channels": [
      "email"
    ],
    "scheduled_for": null,
    "next_step": "preview_email, then preview_recipients"
  }
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444"
}

{
  "mode": "draft",
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "data": {
    "subject": "Sarah, fall tune-up time",
    "html": "<!DOCTYPE html><html><body>...</body></html>"
  },
  "warnings": [
    {
      "code": "no_logo_variable",
      "message": "The email has no logo. Use {{company_logo_light}} in the header."
    }
  ],
  "preview_url": "https://app.example.com/preview/email/<token>",
  "expires_in_minutes": 30,
  "note": "This is the stored draft rendered by the send path, so it is what your contacts will receive. Names and the unsubscribe link are samples."
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444"
}

{
  "sent": [
    "email"
  ],
  "skipped": [
    {
      "channel": "sms",
      "reason": "The campaign has no SMS text yet."
    }
  ],
  "sent_to": "your own address and number only"
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444"
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "channels": [
    "email"
  ],
  "counts": {
    "reachable": 412,
    "email": 412,
    "sms": 0,
    "both": 0,
    "unreachable": 37
  },
  "opted_out": {
    "email": 21,
    "sms": 0
  },
  "from": {
    "name": "Example Service Group",
    "email": "info@mail.esg.example"
  },
  "sms_from": null,
  "data": {
    "sample": [
      {
        "first_name": "Dana",
        "channel": "email"
      },
      {
        "first_name": null,
        "channel": "email"
      }
    ],
    "sms_preview": null
  },
  "confirm_with_recipient_count": 412
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "confirm": {
    "recipient_count": 412,
    "intent": "Send the fall tune-up offer to everyone"
  },
  "idempotency_key": "fall-tuneup-0930"
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "sent": 409,
  "failed": 3,
  "email": {
    "sent": 409,
    "failed": 3
  },
  "sms": {
    "sent": 0,
    "failed": 0
  }
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "action": "schedule",
  "scheduled_for": "2026-10-06T14:00:00.000Z",
  "confirm": {
    "recipient_count": 412,
    "intent": "Send Monday morning"
  }
}

{
  "campaign_id": "44444444-4444-4444-8444-444444444444",
  "status": "scheduled",
  "scheduled_for": "2026-10-06T14:00:00.000Z",
  "recipient_count": 412
}