Skip to content

Update Schedule

Base URL

PATCH https://schedulingapi.datashake.com/schedules/:schedule_id

❗ Make sure to replace :schedule_id with the actual Schedule ID.

Request parameters

name

string Name for the schedule. Optional.

Code example 
curl --location --request PATCH 'https://schedulingapi.datashake.com/schedules/123' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "schedule_name": "Eataly NYC Downtown Schedule"
}'

import requests

url = "https://schedulingapi.datashake.com/schedules/123"
body = {
    "schedule_name": "Eataly NYC Downtown Schedule"
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon
disabled

boolean Whether this schedule is disabled or not. Optional.

Code example 
curl --location --request PATCH 'https://schedulingapi.datashake.com/schedules/123' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 1234567890' \
--data '{
    "disabled": false
}'

import requests

url = "https://schedulingapi.datashake.com/schedules/123"
body = {
    "disabled": False
}
headers = {
    "x-api-key": "1234567890"
}
response = requests.post(
    url=url,
    body=body,
    headers=headers
)

coming soon

coming soon

coming soon

Response

API Response example 
{
    "status": "success",
    "results": [
        {
            "schedule_id": 223,
            "frequency": "daily",
            "endpoint": "https://reviewindexapi.datashake.com/profiles",
            "schedule_name": "Eataly NYC Downtown Schedule",
            "disabled": false,
            "last_successful_request_id": null,
            "payload": {
                "body": {},
                "headers": {},
                "query_params": {
                    "name": "Eataly NYC Downtown",
                    "update": "true",
                    "city": "New York",
                    "callback": "https://www.example.com/callback",
                }
            },
            "service": "riapi",
            "last_successful_run": "2023-09-13T21:20:00",
            "last_request_id": "1694635207488650442-b29cf7e4-0363-49"
        }
    ]
}