Skip to main content
Request

curl --location 'https://openapi.gs-robot.com/openapi/v3/schedules/plans/simple/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
"dayOfMonth": 29,
"month": 8,
"operationType": 2,
"planStartTime": "11:00",
"planStopTime": "12:00",
"planUuid": "00000000-0000-4000-8000-000000000001",
"robotSn": "TEST00-0000-000-B088",
"taskName": "Weekday cleaning schedule (updated)",
"year": 2026
}'

Version requirement: This API is supported only on AIO software version 1.6 and later.

Notes​

  • This API supports partial updates. Apart from robotSn, planUuid, operationType, year, month, and dayOfMonth, send only fields that need to change. Omitted business fields retain their existing values; sending null is not recommended.
  • year, month, and dayOfMonth only identify the target date. operationType=1 updates only that date, while operationType=2 updates that date and all future schedules.
  • If supplied, mapResourceList replaces the entire existing list. Every item requires mapId, mapResourceId, and mapResourceType, using actual values from /openapi/v3/maps/schedule-resources/list.
  • If supplied, workMode.mode is required and all fields must be based on the actual resource-query response. If mode alone is ambiguous, also send subType, type, or strength.
  • taskAdvanceConfig is merged by child field; omitted child fields retain their existing values.
  • Mutation APIs use integer planExecuteType: 1 for a timed task or 2 for a quantitative task. For a quantitative task, send "planStopTime": "" to clear the existing end time. A timed task cannot have an empty end time.
  • Times use HH:mm in 24-hour format. A non-empty end time must be later than the start time; crossing midnight is not supported.
Response

{
"code": 0,
"data": {},
"msg": "success"
}