Skip to main content
Requires an API key with full_access scope. All fields are optional. Only include the fields you want to change.

Path parameters

string
required
The unique identifier of the project.
string
required
The unique identifier of the job.

Body

string
Job name. 1 to 100 characters.
string
Job description. Max 1000 characters.
string
Job type. Must match one of the job types configured in your workspace.
string
Job status. One of: draft, not_started, planned, in_progress, completed, on_hold, weather_delayed, technical_issues, cancelled, aborted, other.
Your workspace may show custom display names for these statuses in the dashboard. The API always uses the predefined values listed above. Use other with other_status_reason for statuses that don’t map to a predefined value.
string
Priority level. One of: low, medium, high.
string
Either one_time or recurring. Changing this will regenerate job occurrences.
string
Start date in ISO 8601 format. Cannot be more than 6 months in the past.
string | null
End date in ISO 8601 format. Must be on or after start_date. Set to null to clear.
number | null
Latitude of the job location. Between -90 and 90. Must be provided together with longitude. Set both to null to clear.
number | null
Longitude of the job location. Between -180 and 180. Must be provided together with latitude. Set both to null to clear.
string
Notes for the inspection. Max 2000 characters.
string[] | null
Array of capture types. Valid values: drone_inspection, thermal_inspection, video_capture, 3d_mapping, lidar_scan, orthomosaic, ground_smartphone, ground_360, panorama. Max 20 items, no duplicates. Set to null to clear.
string | null
Your own identifier for this job. Max 255 characters. Set to null to clear.
string
Required when status is other. 1 to 200 characters.

Recurring job fields

These fields only apply when job_pattern is recurring. Changing any of these will regenerate job occurrences.
string | null
Recurrence frequency. One of: daily, weekly, monthly, yearly, flexible. Set to null to clear.
number | null
Repeat every N periods. Between 1 and 365. Cannot be used with flexible frequency. Set to null to clear.
number[] | null
Days of the week. Array of numbers where 0 = Sunday, 6 = Saturday. Max 7 values. Set to null to clear.
number | null
Which week of the month. One of: 1, 2, 3, 4, or -1 (last week). Set to null to clear.
number[] | null
Multiple weeks of the month. Array of values: 1, 2, 3, 4, or -1 (last week). Max 5 values, no duplicates. Set to null to clear.
number | null
Number of flights per occurrence. Between 1 and 10. Set to null to clear.

Response

string
Confirmation message.

Errors

400 Bad Request - Validation failed.
Other validation messages include:
  • status must be one of: draft, not_started, in_progress, ...
  • priority must be one of: low, medium, high
  • start_date must be a valid ISO date string
  • end_date cannot be before start_date
  • latitude must be between -90 and 90
  • Both latitude and longitude must be provided together
  • other_status_reason is required when status is "other"
404 Not Found - Job not found.