Sign in
Missions

Create mission

Creates a mission. Body may include siteIds and/or clusterIds. When a cluster ID is provided, all sites in that cluster are included. The server expands cluster IDs into individual sites, creating a SiteVisit for every site and a ClusterVisit for each fully-covered cluster.

post/missions

Headers

Idempotency-Keystring uuid

Idempotency key for POST requests. If a transaction with the same key already exists for the org, the server returns the original response without re-executing. Keys are valid for 48 hours.

Request body

namestring required
descriptionstring required
status'scheduled' | 'canceled' | 'in-progress' | 'recurring' | 'complete' required
detailLevel'low' | 'medium' | 'high' required
scheduledFornumber required

Unix timestamp in milliseconds

estimatedCompletionTimenumber required

Unix timestamp in milliseconds

dueDatenumber

Unix timestamp in milliseconds

recurrence'daily' | 'weekly' | 'monthly' | 'yearly'
estimatedCostnumber required
siteGeometriesstring[]
siteIdsstring[]

Individual site IDs to include in the mission

clusterIdsstring[]

Cluster IDs; all sites in these clusters will be included

Response

Created

transactionIdstring uuid required

Changes