Edit Relay Task Configuration

PUT

/openapi/v2.0/task/api/v1/workspaces/{workspace_id}/flight-tasks/relay-missions/{relay_mission_id}

Modify adjustable parameters of executing/paused relay task (end time / lost-control action / primary and backup aircraft return altitudes / relay aircraft early departure time / point-to-fly mode / speed, etc.) without rebuilding the task.

Effective Constraint: Task must be in running or paused state to allow editing; editing is rejected in other states (e.g. terminated / success).

Non-Modifiable Items: This API cannot modify primary/backup aircraft SNs and task point location — to switch executing aircraft, use PUT /switch; adjusting task point location affects relay point calculation; must be cancelled and rebuilt.

Call Requirements: Logged-in project member with flight task edit permission in workspace.

Request

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "end_at": 1735689600,
    "out_of_control_action": "ReturnHome",
    "main_rth_altitude": 150,
    "secondary_rth_altitude": 150,
    "early_departure_time": 300
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/openapi/v2.0/task/api/v1/workspaces//flight-tasks/relay-missions/12345' \
--header 'x-user-token;' \
--header 'x-user-token;' \
--header 'X-Request-Id: 5dff27bd-693c-4ace-979d-e26e920d497a' \
--header 'X-Request-Id;' \
--header 'X-Project-Uuid;' \
--header 'Content-Type: application/json' \
--data '{
    "end_at": 1735689600,
    "out_of_control_action": "ReturnHome",
    "main_rth_altitude": 150,
    "secondary_rth_altitude": 150,
    "early_departure_time": 300
}'

Responses

🟢200

application/json

Operation Successful

Bodyapplication/json

Example

{
    "code": 0,
    "message": "success",
    "data": null
}

🟠400

🔴500

Modified at 2026-06-15 13:36:31

Calculate Best Relay Position for Relay Task

Trigger Relay Aircraft Active Takeoff