Create Campaign

curl -X POST https://api.v2.dealmachine.com/v1/mail/campaigns \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spring Seller Campaign",
    "property_ids": [123456, 789012],
    "address_to": "owner",
    "steps": [{
      "design_id": "design-uuid-123"
    }],
    "contact_name": "John Smith",
    "contact_phone": "555-123-4567",
    "return_address_id": "42",
    "launch": true
  }'

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": 42,
    "name": "Spring Seller Campaign",
    "status": "active",
    "type": "one_off",
    "audience_kind": "properties",
    "property_ids": ["123456", "789012"],
    "contact_ids": [],
    "list_ids": [],
    "total_recipients": 2,
    "total_sent": 0,
    "total_delivered": 0,
    "steps": [{
      "id": "1",
      "step_order": 1,
      "design_id": "design-uuid-123",
      "delay_days": 0,
      "interval_days": 0,
      "repeat_count": 1
    }],
    "created_at": "2026-03-11T14:23:45Z",
    "launched_at": "2026-03-11T14:23:46Z"
  }
}

POST

mail

campaigns

curl -X POST https://api.v2.dealmachine.com/v1/mail/campaigns \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spring Seller Campaign",
    "property_ids": [123456, 789012],
    "address_to": "owner",
    "steps": [{
      "design_id": "design-uuid-123"
    }],
    "contact_name": "John Smith",
    "contact_phone": "555-123-4567",
    "return_address_id": "42",
    "launch": true
  }'

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": 42,
    "name": "Spring Seller Campaign",
    "status": "active",
    "type": "one_off",
    "audience_kind": "properties",
    "property_ids": ["123456", "789012"],
    "contact_ids": [],
    "list_ids": [],
    "total_recipients": 2,
    "total_sent": 0,
    "total_delivered": 0,
    "steps": [{
      "id": "1",
      "step_order": 1,
      "design_id": "design-uuid-123",
      "delay_days": 0,
      "interval_days": 0,
      "repeat_count": 1
    }],
    "created_at": "2026-03-11T14:23:45Z",
    "launched_at": "2026-03-11T14:23:46Z"
  }
}

Create a new postcard campaign. By default, the campaign is created in draft status. Set launch to true to send immediately. Audience: Provide exactly one audience type: property_ids, contact_ids, or list_ids. Mixing audience types in a single campaign is not supported. Design: Each step can reference an existing design_id or provide a design_prompt to generate a design on the fly. Since designs are HTML-based, generation is instant — no polling required. The postcard size is determined by the design. Credits: You don’t need credits to create a draft. Credits are checked when you launch the campaign (either via launch: true or POST /campaigns/{id}/send).

string

required

Campaign name (max 255 characters)

string

Campaign description (max 5000 characters)

number[]

Property IDs to send to. Mutually exclusive with contact_ids and list_ids.

number[]

Contact (person) IDs to send to. Mutually exclusive with property_ids and list_ids.

string[]

Saved list IDs to pull audience from. Mutually exclusive with property_ids and contact_ids.

string

Who to address mail to: owner (mailing address) or resident (property address). Required when using property_ids and for property-based list_ids. Not needed for contact_ids or people lists.

object[]

required

Mail steps (1-5). Each step needs either a design_id or design_prompt.

Show Step properties

string

Existing design ID to use

string

AI prompt to generate an HTML design instantly

number

default:"0"

Days to wait after the previous step

number

default:"0"

Days between repeated sends

number

default:"1"

Number of times to send this step (1-12)

boolean

default:"false"

Skip this step if the recipient has responded

string

Your name displayed on the postcard

string

Contact phone number on the postcard

string

Contact email on the postcard

string

URL for the QR code on the postcard

string

ID of a saved return address

object

Inline return address (alternative to return_address_id)

Show Return address properties

string

required

Name on the return address

string

required

Street address

string

Apt/Suite/Unit

string

required

City

string

required

Two-letter state code

string

required

ZIP code

boolean

default:"false"

Launch the campaign immediately after creation. If false, the campaign is created in draft status and you can launch it later with POST /campaigns/{id}/send.

curl -X POST https://api.v2.dealmachine.com/v1/mail/campaigns \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spring Seller Campaign",
    "property_ids": [123456, 789012],
    "address_to": "owner",
    "steps": [{
      "design_id": "design-uuid-123"
    }],
    "contact_name": "John Smith",
    "contact_phone": "555-123-4567",
    "return_address_id": "42",
    "launch": true
  }'

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": 42,
    "name": "Spring Seller Campaign",
    "status": "active",
    "type": "one_off",
    "audience_kind": "properties",
    "property_ids": ["123456", "789012"],
    "contact_ids": [],
    "list_ids": [],
    "total_recipients": 2,
    "total_sent": 0,
    "total_delivered": 0,
    "steps": [{
      "id": "1",
      "step_order": 1,
      "design_id": "design-uuid-123",
      "delay_days": 0,
      "interval_days": 0,
      "repeat_count": 1
    }],
    "created_at": "2026-03-11T14:23:45Z",
    "launched_at": "2026-03-11T14:23:46Z"
  }
}

List Campaigns Get Campaign

⌘I

Driving

Driving Assignments

Driving Targets

Driving Tags

Driving Notes

Mail

Mail Campaigns

Mail Designs

Mail Return Addresses

Mail Wallet

Mail Settings

Mail Analytics