curl https://api.v2.dealmachine.com/v1/mail/campaigns?status=active \
-H "Authorization: Bearer dm_sk_live_xxx"
const response = await fetch('https://api.v2.dealmachine.com/v1/mail/campaigns?status=active', {
headers: { 'Authorization': 'Bearer dm_sk_live_xxx' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": 42,
"name": "Spring Seller Campaign",
"description": "Postcards for potential sellers",
"status": "active",
"type": "one_off",
"source": "api",
"contact_name": "John Smith",
"contact_phone": "555-123-4567",
"contact_email": "john@example.com",
"qr_code_link": null,
"return_name": "Acme Real Estate",
"return_address_1": "456 Business Ave",
"return_address_2": null,
"return_city": "Austin",
"return_state": "TX",
"return_zip": "78702",
"total_recipients": 150,
"total_sent": 120,
"total_delivered": 115,
"created_at": "2026-03-01T14:23:45Z",
"updated_at": "2026-03-10T09:15:00Z",
"launched_at": "2026-03-02T10:00:00Z",
"completed_at": null,
"steps": [
{
"id": "1",
"step_order": 1,
"step_name": "Send",
"design_id": "design-uuid-123",
"design_prompt": null,
"delay_days": 0,
"interval_days": 0,
"repeat_count": 1,
"skip_if_responded": false
}
]
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 1,
"has_more": false
}
}
Mail Campaigns
List Campaigns
List mail campaigns for your organization
GET
/
v1
/
mail
/
campaigns
curl https://api.v2.dealmachine.com/v1/mail/campaigns?status=active \
-H "Authorization: Bearer dm_sk_live_xxx"
const response = await fetch('https://api.v2.dealmachine.com/v1/mail/campaigns?status=active', {
headers: { 'Authorization': 'Bearer dm_sk_live_xxx' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": 42,
"name": "Spring Seller Campaign",
"description": "Postcards for potential sellers",
"status": "active",
"type": "one_off",
"source": "api",
"contact_name": "John Smith",
"contact_phone": "555-123-4567",
"contact_email": "john@example.com",
"qr_code_link": null,
"return_name": "Acme Real Estate",
"return_address_1": "456 Business Ave",
"return_address_2": null,
"return_city": "Austin",
"return_state": "TX",
"return_zip": "78702",
"total_recipients": 150,
"total_sent": 120,
"total_delivered": 115,
"created_at": "2026-03-01T14:23:45Z",
"updated_at": "2026-03-10T09:15:00Z",
"launched_at": "2026-03-02T10:00:00Z",
"completed_at": null,
"steps": [
{
"id": "1",
"step_order": 1,
"step_name": "Send",
"design_id": "design-uuid-123",
"design_prompt": null,
"delay_days": 0,
"interval_days": 0,
"repeat_count": 1,
"skip_if_responded": false
}
]
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 1,
"has_more": false
}
}
List all mail campaigns with optional filtering by status and search.
number
default:"1"
Page number
number
default:"25"
Results per page (1-100)
string
Filter by status:
draft, active, paused, completed, cancelledstring
Search by campaign name
curl https://api.v2.dealmachine.com/v1/mail/campaigns?status=active \
-H "Authorization: Bearer dm_sk_live_xxx"
const response = await fetch('https://api.v2.dealmachine.com/v1/mail/campaigns?status=active', {
headers: { 'Authorization': 'Bearer dm_sk_live_xxx' }
});
const { data, pagination } = await response.json();
{
"data": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": 42,
"name": "Spring Seller Campaign",
"description": "Postcards for potential sellers",
"status": "active",
"type": "one_off",
"source": "api",
"contact_name": "John Smith",
"contact_phone": "555-123-4567",
"contact_email": "john@example.com",
"qr_code_link": null,
"return_name": "Acme Real Estate",
"return_address_1": "456 Business Ave",
"return_address_2": null,
"return_city": "Austin",
"return_state": "TX",
"return_zip": "78702",
"total_recipients": 150,
"total_sent": 120,
"total_delivered": 115,
"created_at": "2026-03-01T14:23:45Z",
"updated_at": "2026-03-10T09:15:00Z",
"launched_at": "2026-03-02T10:00:00Z",
"completed_at": null,
"steps": [
{
"id": "1",
"step_order": 1,
"step_name": "Send",
"design_id": "design-uuid-123",
"design_prompt": null,
"delay_days": 0,
"interval_days": 0,
"repeat_count": 1,
"skip_if_responded": false
}
]
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total": 1,
"has_more": false
}
}
⌘I