# API

![](https://628257366-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJR7CoHgmmOgtuyR2MgLf%2Fuploads%2Fvok47bfjKUO1OLFrfTVH%2Flogo.svg?alt=media\&token=0cbda9d6-3d22-4e09-a63d-f800b9029874)

## API Key

Visit [cronfree.com](https://cronfree.com/)

{% embed url="<https://cronfree.com/>" %}

Sign In or Sign Up to get a License Key

<figure><img src="https://628257366-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJR7CoHgmmOgtuyR2MgLf%2Fuploads%2F0pM0fqDFjfMyKXwpApGY%2FScreenshot%202024-02-09%20at%2011.49.20%20AM.png?alt=media&#x26;token=f2eb73ba-141e-4f03-be5f-6590d0e56ae3" alt=""><figcaption></figcaption></figure>

## Subscribe POST

```bash
curl --location 'https://login.cronfree.com/zapier/schedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123",
    "wdays": ["-1"],
    "months": ["-1"],
    "mdays": ["-1"],
    "hours": ["-1"],
    "minutes": ["-1"],
    "timezone": ["Africa/Abidjan"]
}'
```

### JSON Body

hookUrl: string

* The url to receive a POST message at a certain interval

license\_key: string

* From Cronfree account

wdays: string\[]

* -1: Every Day
* 0: Sunday&#x20;
* 1: Monday
* 2: Tuesday
* 3: Wednesday
* 4: Thursday
* 5: Friday
* 6: Saturday

months: string\[]

* -1: Every Month
* 1: January
* 2: Feburary
* ...
* 12: December

Hours: string\[]

* -1: Every Hour
* 0: 00:00
* 1: 01:00
* 2: 02:00
* ...
* 23: 23:00

Minutes: string\[]

* -1: Every Minute
* 0: 00:00
* 1: 00:01
* 2: 00:02
* 59: 00:59

Timezone: string

<details>

<summary>Timezones</summary>

\[ "Africa/Abidjan", "Africa/Accra", "Africa/Addis\_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar\_es\_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El\_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao\_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos\_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La\_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio\_Gallegos", "America/Argentina/Salta", "America/Argentina/San\_Juan", "America/Argentina/San\_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia\_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa\_Vista", "America/Bogota", "America/Boise", "America/Cambridge\_Bay", "America/Campo\_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad\_Juarez", "America/Costa\_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson\_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El\_Salvador", "America/Fort\_Nelson", "America/Fortaleza", "America/Glace\_Bay", "America/Goose\_Bay", "America/Grand\_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell\_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La\_Paz", "America/Lima", "America/Los\_Angeles", "America/Lower\_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico\_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New\_York", "America/Nome", "America/Noronha", "America/North\_Dakota/Beulah", "America/North\_Dakota/Center", "America/North\_Dakota/New\_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port\_of\_Spain", "America/Porto\_Velho", "America/Puerto\_Rico", "America/Punta\_Arenas", "America/Rankin\_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio\_Branco", "America/Santarem", "America/Santiago", "America/Santo\_Domingo", "America/Sao\_Paulo", "America/Scoresbysund", "America/Sitka", "America/St\_Barthelemy", "America/St\_Johns", "America/St\_Kitts", "America/St\_Lucia", "America/St\_Thomas", "America/St\_Vincent", "America/Swift\_Current", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Choibalsan", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho\_Chi\_Minh", "Asia/Hong\_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala\_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom\_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape\_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South\_Georgia", "Atlantic/St\_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken\_Hill", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord\_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle\_of\_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San\_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago\_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port\_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis" ]

</details>

## Examples

```bash
# Trigger every minute

curl --location 'https://login.cronfree.com/zapier/schedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123",
    "wdays": ["-1"],
    "months": ["-1"],
    "mdays": ["-1"],
    "hours": ["-1"],
    "minutes": ["-1"],
    "timezone": ["Africa/Abidjan"]
}'
```

```bash
# Trigger every minute on Sundays

curl --location 'https://login.cronfree.com/zapier/schedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123",
    "wdays": ["0"],
    "months": ["-1"],
    "mdays": ["-1"],
    "hours": ["-1"],
    "minutes": ["-1"],
    "timezone": ["Africa/Abidjan"]
}'
```

```bash
# Trigger every day at 04:22 AM

curl --location 'https://login.cronfree.com/zapier/schedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123",
    "wdays": ["-1"],
    "months": ["-1"],
    "mdays": ["-1"],
    "hours": ["4"],
    "minutes": ["22"],
    "timezone": ["Africa/Abidjan"]
}'
```

```bash
# Trigger every Sunday & Monday at 4:22 AM

curl --location 'https://login.cronfree.com/zapier/schedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123",
    "wdays": ["0", "1"],
    "months": ["-1"],
    "mdays": ["-1"],
    "hours": ["4"],
    "minutes": ["22"],
    "timezone": ["Africa/Abidjan"]
}'
```

## Unsubscribe

You can view your usage when you sign into Cronfree.

```bash
curl --location 'https://login.cronfree.com/zapier/unschedule' \
--header 'Content-Type: application/json' \
--data '{
    "hookUrl": "https://db82-2601-58c-4200-63c0-3578-cc6-ff31-887.ngrok-free.app",
    "license_key": "l1c3ncee-k3yy-h3r3-hel0-123456789123"
}'
```
