API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Rotation settings

Remove one scheduled rotation job, or all system jobs of the given slots

Use this to stop automatic rotation. With a job id it removes that job from each listed position; with an empty or null id it removes every system job of those positions. Selling-port interval jobs are not touched.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • removeRotationScheduleJob
POST/v2/schedule/rotation_remove_job

Request body application/json · required

positionsinteger[]required
idinteger | nullrequired

Job id from rotation_jobs; null removes all system jobs of the positions.

Responses

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
Missing param "positions"!positions is empty.Send at least one position.
Remove schedule rotation failed!positions or id is missing from the body or removal failed.Send both fields (id may be null).
Verified against XProxy v21.3.2 on Nov 17, 2026