Update user scheduled event

Updates the scheduling parameters of a specific event belonging to the given user and returns the complete list of the user's scheduled events.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/users/{username}/scheduledEvents/{scheduledEventId}.do

Updates the scheduling parameters of a specific event belonging to the given user and returns the complete list of the user's scheduled events. The event's period (1=DAY, 2=WEEK, 3=MONTH), frequency (number of firings per period), and startAt (delay in minutes) can be modified via form parameters; each one not sent keeps its current value. The update is validated against maximum period constraints.

Path Params

username string required

Login username of the user who owns the scheduled event — the caller's own, or one whose role the caller's admin role manages

john.doe

scheduledEventId integer required

Unique identifier of the scheduled event to update

901

Form Params

frequency integer

Frequency of the event (0-200). Omitted on update keeps it

1

period integer

Period type: 1 = daily, 2 = weekly, 3 = monthly. Omitted on update keeps it

1

startAt integer

Start time offset in minutes from midnight. Omitted on update keeps it

480

Responses

200

Scheduled event updated successfully

400

Bad request - validation error

401

Unauthorized - authentication error

403

Forbidden — insufficient permissions

404

No such user, the user is neither the caller nor an account the caller's admin role manages, or the user has no such scheduled event

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'frequency=1' \
  --data-urlencode 'period=1' \
  --data-urlencode 'startAt=480'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"frequency": "1", "period": "1", "startAt": "480"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"frequency":"1","period":"1","startAt":"480"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("frequency=1&period=1&startAt=480"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["frequency"] = "1", ["period"] = "1", ["startAt"] = "480" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do", strings.NewReader(`frequency=1&period=1&startAt=480`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'frequency=1&period=1&startAt=480');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/users/john.doe/scheduledEvents/901.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('frequency' => "1", 'period' => "1", 'startAt' => "480")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body