Updates an existing scheduled event for a project identified by API key. The
uid parameter defines which event to modify.
Request Fields
These are passed in at the top level of the request.
| Key | Type | Description |
|---|---|---|
| uid | string Optional |
A user-specified identifier to refer to this scheduled event on subsequent API calls. |
| schedule | string Optional |
Defines the schedule to follow when sending this batch. Must conform to one of the supported schedule formats. |
| status | string Optional |
Status of the scheduled event, one of active or suspend |
| metadata | string Optional |
Updated metadata for the scheduled event. |
Request Structure
{
"api_key":"__PROJECT_API__KEY__",
"uid": "__UID__",
"schedule": "every 2 mins",
"status": "suspend"
}Response 200 OK
Upon successful update the following is returned:
{
"response": {
"status": "ok",
"uid": "__UID__"
},
"data": {
"uid":"__UID__",
"status": "suspend",
"frequency": "every 2 mins",
"event_type": "repeatable",
"scheduled_at": null,
"metadata": {
"...": "..."
}
}
}Response 404 Not Found
If the UID cannot be found for the given project the following is returned:
{
"response": {
"status": "not_found",
"uid": "__UID__",
"message": "Can not find scheduled event from the given UID"
}
}