deactivate_schedule
Stop automated workflow execution by disabling a specific schedule in Alteryx Server using its unique identifier.
Instructions
Deactivate a schedule by its ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schedule_id | Yes |
Implementation Reference
- src/tools.py:605-628 (handler)Core handler implementation for the 'deactivate_schedule' tool. Fetches the current schedule, creates an UpdateScheduleContract with enabled=False, and updates the schedule via the API.
def deactivate_schedule(self, schedule_id: str): """Deactivate a schedule by its ID""" try: schedule = self.schedules_api.schedules_get_schedule(schedule_id) if not schedule: return "Error: Schedule not found" contract = server_client.UpdateScheduleContract( workflow_id=schedule.workflow_id, owner_id=schedule.owner_id, iteration=schedule.iteration, name=schedule.name, comment=schedule.comment, priority=schedule.priority, worker_tag=schedule.worker_tag, enabled=False, credential_id=schedule.credential_id, time_zone=schedule.time_zone, questions=schedule.questions, ) api_response = self.schedules_api.schedules_update_schedule(schedule_id, contract) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}" - src/mcp_server.py:314-317 (registration)MCP tool registration for 'deactivate_schedule'. This decorator registers the tool with the MCP server and delegates execution to the underlying tools.deactivate_schedule method.
@self.app.tool() def deactivate_schedule(schedule_id: str): """Deactivate a schedule by its ID""" return self.tools.deactivate_schedule(schedule_id)