All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ScheduleUpdateParams
 implements Params
                    
```
Updates one or more existing schedules with new timing, data, or other properties. All specified schedule IDs will be updated with the same values. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the actor, recipient, and tenant fields.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ScheduleUpdateParams.Builder`	A builder for ScheduleUpdateParams.
`public final class`	`ScheduleUpdateParams.Body`	A request to update a schedule.
`public final class`	`ScheduleUpdateParams.Data`	An optional map of data to pass into the workflow execution.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<String>`	`scheduleIds()`	A list of schedule IDs.
`final Optional<RecipientReference>`	`actor()`	A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
`final Optional<ScheduleUpdateParams.Data>`	`data()`	An optional map of data to pass into the workflow execution.
`final Optional<OffsetDateTime>`	`endingAt()`	The ending date and time for the schedule.
`final Optional<List<ScheduleRepeatRule>>`	`repeats()`	The repeat rule for the schedule.
`final Optional<OffsetDateTime>`	`scheduledAt()`	The starting date and time for the schedule.
`final Optional<InlineTenantRequest>`	`tenant()`	An request to set a tenant inline.
`final JsonField<List<String>>`	`_scheduleIds()`	Returns the raw JSON value of scheduleIds.
`final JsonField<RecipientReference>`	`_actor()`	Returns the raw JSON value of actor.
`final JsonField<ScheduleUpdateParams.Data>`	`_data()`	Returns the raw JSON value of data.
`final JsonField<OffsetDateTime>`	`_endingAt()`	Returns the raw JSON value of endingAt.
`final JsonField<List<ScheduleRepeatRule>>`	`_repeats()`	Returns the raw JSON value of repeats.
`final JsonField<OffsetDateTime>`	`_scheduledAt()`	Returns the raw JSON value of scheduledAt.
`final JsonField<InlineTenantRequest>`	`_tenant()`	Returns the raw JSON value of tenant.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ScheduleUpdateParams.Builder`	`toBuilder()`
`final ScheduleUpdateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ScheduleUpdateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ScheduleUpdateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - scheduleIds
```
 final List<String> scheduleIds()
```
    A list of schedule IDs.
  - actor
```
 final Optional<RecipientReference> actor()
```
    A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
  - data
```
 final Optional<ScheduleUpdateParams.Data> data()
```
    An optional map of data to pass into the workflow execution.
  - endingAt
```
 final Optional<OffsetDateTime> endingAt()
```
    The ending date and time for the schedule.
  - repeats
```
 final Optional<List<ScheduleRepeatRule>> repeats()
```
    The repeat rule for the schedule.
  - scheduledAt
```
 final Optional<OffsetDateTime> scheduledAt()
```
    The starting date and time for the schedule.
  - tenant
```
 final Optional<InlineTenantRequest> tenant()
```
    An request to set a tenant inline.
  - _scheduleIds
```
 final JsonField<List<String>> _scheduleIds()
```
    Returns the raw JSON value of scheduleIds.
    Unlike scheduleIds, this method doesn't throw if the JSON field has an unexpected type.
  - _actor
```
 final JsonField<RecipientReference> _actor()
```
    Returns the raw JSON value of actor.
    Unlike actor, this method doesn't throw if the JSON field has an unexpected type.
  - _data
```
 final JsonField<ScheduleUpdateParams.Data> _data()
```
    Returns the raw JSON value of data.
    Unlike data, this method doesn't throw if the JSON field has an unexpected type.
  - _endingAt
```
 final JsonField<OffsetDateTime> _endingAt()
```
    Returns the raw JSON value of endingAt.
    Unlike endingAt, this method doesn't throw if the JSON field has an unexpected type.
  - _repeats
```
 final JsonField<List<ScheduleRepeatRule>> _repeats()
```
    Returns the raw JSON value of repeats.
    Unlike repeats, this method doesn't throw if the JSON field has an unexpected type.
  - _scheduledAt
```
 final JsonField<OffsetDateTime> _scheduledAt()
```
    Returns the raw JSON value of scheduledAt.
    Unlike scheduledAt, this method doesn't throw if the JSON field has an unexpected type.
  - _tenant
```
 final JsonField<InlineTenantRequest> _tenant()
```
    Returns the raw JSON value of tenant.
    Unlike tenant, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ScheduleUpdateParams.Builder toBuilder()
```
  - _body
```
 final ScheduleUpdateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ScheduleUpdateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ScheduleUpdateParams.
    The following fields are required:
    .scheduleIds()

Class ScheduleUpdateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

scheduleIds

actor

data

endingAt

repeats

scheduledAt

tenant

_scheduleIds

_actor

_data

_endingAt

_repeats

_scheduledAt

_tenant

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder