Update Campaign

curl -X PATCH https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4 \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Campaign Name"}'

PATCH

mail

campaigns

{id}

curl -X PATCH https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4 \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Campaign Name"}'

Update a campaign that is in draft status. Active, paused, completed, or cancelled campaigns cannot be updated. If you update the audience, provide exactly one audience type: property_ids, contact_ids, or list_ids. Mixing audience types in a single request is not supported.

string

required

Campaign ID (UUID)

string

Campaign name

string

Campaign description

number[]

Replace the audience with property IDs. Mutually exclusive with contact_ids and list_ids.

number[]

Replace the audience with contact (person) IDs. Mutually exclusive with property_ids and list_ids.

string[]

Replace the audience with saved list IDs. Mutually exclusive with property_ids and contact_ids.

string

Required when updating to property_ids and for property-based list_ids. Use owner for mailing addresses or resident for property addresses.

string

Contact name on the postcard

string

Contact phone on the postcard

string

Contact email on the postcard

string

QR code URL

curl -X PATCH https://api.v2.dealmachine.com/v1/mail/campaigns/a1b2c3d4 \
  -H "Authorization: Bearer dm_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Campaign Name"}'

Get Campaign Cancel 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