---
title: "Update user scheduled event"
type: reference
method: POST
path: /rest-api/users/{username}/scheduledEvents/{scheduledEventId}.do
tag: "Users"
---

# Update user scheduled event

`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

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `username` | string | yes | `john.doe` | Login username of the user who owns the scheduled event — the caller's own, or one whose role the caller's admin role manages |
| `scheduledEventId` | integer | yes | `901` | Unique identifier of the scheduled event to update |

## Form params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `frequency` | integer | no | `1` | Frequency of the event (0-200). Omitted on update keeps it |
| `period` | integer | no | `1` | Period type: 1 = daily, 2 = weekly, 3 = monthly. Omitted on update keeps it |
| `startAt` | integer | no | `480` | Start time offset in minutes from midnight. Omitted on update keeps it |

## 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

## Example request

```bash
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'
```

Source: https://epom.com/ad-server/docs/api/users/post-users-scheduledevents