Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Get Campaign

Retrieve a campaign with all its steps and current status.
status is one of draft, ready, active, paused, or ended. See List Campaigns for what each status means. Campaigns that were Completed or Cancelled are reported as ended.
Two fields tell you whether you can add properties:
  • is_accepting_properties: true when the campaign was built to take properties after it starts. Campaigns saved as ready with no audience, campaigns created through the API with accepts_properties: true, and campaigns built in the app's campaign creator are true. Other campaigns, including every campaign created before October 14, 2026, are false and keep running as before.
  • can_add_properties: true when you can add properties right now, which means is_accepting_properties is true and the status is ready, active, or paused. Add them with Add Properties to Campaign.
path idstringrequired
Campaign ID (UUID)
Request example
curl https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \ -H "Authorization: Bearer dm_sk_live_xxx"
Response example
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "organization_id": 42, "name": "Spring Seller Campaign", "status": "active", "type": "one_off", "is_accepting_properties": true, "can_add_properties": true, "total_recipients": 150, "total_sent": 120, "total_delivered": 115, "steps": [{ "id": "1", "step_order": 1, "design_id": "design-uuid-123", "delay_days": 0, "repeat_count": 1 }], "created_at": "2026-03-01T14:23:45Z", "launched_at": "2026-03-02T10:00:00Z" } }