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

Update Campaign

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.
path idstringrequired
Campaign ID (UUID)
body namestring
Campaign name
body descriptionstring
Campaign description
body property_idsnumber[]
Replace the audience with property IDs. Mutually exclusive with contact_ids and list_ids.
body contact_idsnumber[]
Replace the audience with contact (person) IDs. Mutually exclusive with property_ids and list_ids.
body list_idsstring[]
Replace the audience with saved list IDs. Mutually exclusive with property_ids and contact_ids.
body address_tostring
Required when updating to property_ids and for property-based list_ids. Use owner for mailing addresses or resident for property addresses.
body contact_namestring
Contact name on the postcard
body contact_phonestring
Contact phone on the postcard
body contact_emailstring
Contact email on the postcard
body qr_code_urlstring
QR code URL
Request example
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"}'
DealMachine API
Powered byHolocron