Updates an existing scheduled event for a project identified by API key. The uid parameter defines which event to modify.

The uid parameter is required, but the following are optional:

  • schedule can be supplied using any valid event schedule string.
  • status can be toggled between active and suspend.
  • metadata can be replaced with new message content.

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"
  }
}