Introduction

The Driving API exposes the core Driving workspace through public API endpoints. Use it to assign driving work, save target properties, manage property tags, list tagged properties, and capture notes from the field.

Driving API must be enabled. All endpoints under /v1/driving require the Driving app to be enabled for your organization. If not enabled, endpoints return a 403 with error code driving_not_enabled.

Base URL

https://api.v2.dealmachine.com/v1/driving

Authentication

Driving endpoints use the same Bearer token as the rest of the API:

curl https://api.v2.dealmachine.com/v1/driving/targets \
  -H "Authorization: Bearer dm_sk_live_xxx"

Driving writes require an API key that was created by a DealMachine user. That user is recorded as the creator for targets, tags, notes, and assignments.

Resources

Resource	Description
Assignments	View assignment queues, create assignments, reassign work, and cancel assignments
Targets	Save properties as Driving targets and list target history
Tags	Manage Driving tag definitions and apply tags to properties
Tagged properties	Find properties by Driving tags and tagging activity
Notes	Capture property notes and general Driving notes

Resource Hierarchy

/v1/driving/assignments
/v1/driving/targets
/v1/driving/tags
/v1/driving/tagged-properties
/v1/driving/properties/{propertyId}/tags
/v1/driving/notes
/v1/driving/general-notes

Common Error Codes

Code	Status	Description
`driving_not_enabled`	403	Driving is not enabled for the organization
`driving_assignment_not_found`	404	Assignment does not exist or is not available to the organization
`driving_target_not_found`	404	Target does not exist or is not available to the organization
`driving_tag_not_found`	404	Tag does not exist or is not available to the organization
`driving_note_not_found`	404	Note does not exist or is not available to the organization

List Assignments

⌘I

Driving

Driving Assignments

Driving Targets

Driving Tags

Driving Notes

Mail

Mail Campaigns

Mail Designs

Mail Return Addresses

Mail Wallet

Mail Settings

Mail Analytics

Base URL

Authentication

Resources

Resource Hierarchy

Common Error Codes

​Base URL

​Authentication

​Resources

​Resource Hierarchy

​Common Error Codes

Base URL

Authentication

Resources

Resource Hierarchy

Common Error Codes