Update Schedule by scheduleid
PATCH /v1/tasks/schedule/:scheduleId • validated by `patchTaskSchedule`
← Back to full API referencePATCH/v1/tasks/schedule/:scheduleIdAuthentication required
- Validated by Zod schema: patchTaskSchedule.
Request details
Path params
scheduleId
Required path parameter.
Query params
No explicit query schema was captured for this endpoint.
Body fields
taskId
Type: number
start
Reference to unresolved identifier "z"
duration
Type: number
title
Type: string
description
Type: string
location
Type: string
url
Type: string
lat
Type: number
lon
Type: number
status
Type: string
submission
Type: object
notificationConfig
Type: object
notificationConfig.proximityAlerts
Type: object
notificationConfig.proximityAlerts.enabled (required)
Boolean parser helper from common/utils.zBoolean
notificationConfig.proximityAlerts.intervals
Type: array
Example:
notificationConfig.proximityAlerts.intervals[] (required)
Type: enum
Example: 1_day
notificationConfig.proximityAlerts.emailNotifications
Boolean parser helper from common/utils.zBoolean
capacity
Type: number
isGroupEvent
Boolean parser helper from common/utils.zBoolean
id (required)
Type: number
Default payloads
Sample response
{
"affectedRows": "<affectedRows>"
}
Test this endpoint now
Use your own credentials and execute a live request directly from this page.
2. Select endpoint
PATCH/v1/tasks/schedule/:scheduleIdAuthentication required
Group: Tasks / Schedule
PATCH /v1/tasks/schedule/:scheduleId • validated by `patchTaskSchedule`
- Validated by Zod schema: patchTaskSchedule.
Body fields
- taskId
Type: number
- start
Reference to unresolved identifier "z"
- duration
Type: number
- title
Type: string
- description
Type: string
- location
Type: string
- url
Type: string
- lat
Type: number
- lon
Type: number
- status
Type: string
- submission
Type: object
- notificationConfig
Type: object
- notificationConfig.proximityAlerts
Type: object
- notificationConfig.proximityAlerts.enabledrequired
Boolean parser helper from common/utils.zBoolean
- notificationConfig.proximityAlerts.intervals
Type: array
Ejemplo:
- notificationConfig.proximityAlerts.intervals[]required
Type: enum
Ejemplo: 1_day
- notificationConfig.proximityAlerts.emailNotifications
Boolean parser helper from common/utils.zBoolean
- capacity
Type: number
- isGroupEvent
Boolean parser helper from common/utils.zBoolean
- idrequired
Type: number
3. Prepare request payload
4. Server response
Run a request to inspect the real-time response for your environment.