---
title: "REST API Schedules"
description: "REST API Schedules"
keywords: "REST API Schedules"
url: "https://www.myrapidi.com/wiki/rest_api_schedules"
locale: "en"
published: "2017-08-16T11:07:29Z"
modified: "2023-03-31T11:11:07Z"
---

Schedules enables you to set up Transfers or Groups of Transfers to be run at certain intervals. [Read more on how to use Schedules](/wiki/Schedules)

| **Field** | **Type** | **Notes** |
| --- | --- | --- |
| id | string | |
| type | string | always "schedules" |
| attributes | | |
| code | string | is automatically generated (dont set this field) |
| description | string | is generated on create if not set |
| transfer | string | set either transfercode OR groupcode |
| group | string | set either transfercode OR groupcode |
| interval | integer | |
| interval\_unit | string | "Minutes","Hours","Days","Weeks","Months" |
| status | string | "Ok","Processing","Error","Stopped" |
| error\_handling | string | "Skip","Retry","Stop" (normally use "Skip") |
| last\_datetime | datetime | UTC |
| next\_datetime | datetime | UTC |
| error\_interval | integer | |
| error\_interval\_unit | string | "Minutes","Hours","Days","Weeks","Months" |
| notify\_interval | integer | |
| notify\_interval\_unit | string | "Minutes","Hours","Days","Weeks","Months" |
| notify\_datetime | datetime | UTC |
| start\_time | time | UTC |
| end\_time | time | UTC |
| monday, tuesday, wednesday, thursday, friday, saturday, sunday | boolean | Run on these days |

| **Field** | **Type** | **Notes** |
| --- | --- | --- |
| tags | | |
| comments | | |

| **Query Parameter** | **Notes** |
| --- | --- |
| id | |
| groupcode | groupcode="Nameofgroupcode" -\> ex. groupcode="TEST\_22" |
| transfercode | transfercode="Nameoftransfercode" -\> ex. transfercode="TRABC22" |
| schedulercode | schedulercode="Nameofschedulercode" -\> ex. schedulercode="T\_TRABC22" |
| search | search="searchterm" -\> ex. search="TEST\_22" |
| status | status="OK" , "Processing" , "Error" or "Stopped" |
| due | due="true" |
| overdue | overdue="true" |
| dueoroverdue | dueoroverdue="true" |

[REST API Schedules Get Schedules](https://www.myrapidi.com/wiki/rest_api_schedules_get_schedules.md)

[REST API Schedules Start Schedules](https://www.myrapidi.com/wiki/rest_api_schedules_start_schedules.md)

[REST API Schedules Stop Schedules](https://www.myrapidi.com/wiki/rest_api_schedules_stop_schedules.md)

[REST API Schedules Update Schedules](https://www.myrapidi.com/wiki/rest_api_schedules_update_schedules.md)

[REST API Schedules Update Schedule to run now](https://www.myrapidi.com/wiki/rest_api_schedules_update_schedule_to_run_now.md)

[REST API Schedules List Overdue Schedules](https://www.myrapidi.com/wiki/rest_api_schedules_list_overdue_schedules.md)

[REST API Schedules Create Schedule](https://www.myrapidi.com/wiki/rest_api_schedules_create_schedule.md)

[REST API Schedules Delete Schedule](https://www.myrapidi.com/wiki/rest_api_schedules_delete_schedule.md)