Scheduled Tasks

Delete scheduled task

Permanently deletes a scheduled task. Requires admin role.

delete/api/scheduled-tasks/{id}

Path parameters

idinteger required

Numeric resource ID.

Response

Task deleted.

successboolean required

Example response

{
  "success": true
}

Changes

Changed in 4 of the 36 revisions of this API.149

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 404

      response-property-enum-value-removed

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

    • added the new PAID_REQUIRED enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new PAID_REQUIRED enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new PAID_REQUIRED enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • removed the PRO_REQUIRED enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • removed the PRO_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • removed the PRO_REQUIRED enum value from the code response property for the response status 404

      response-property-enum-value-removed

    • removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation