All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ScheduleCreateParams
 implements Params
                    
```
Creates one or more schedules for a workflow with the specified recipients, timing, and data. Schedules can be one-time or recurring. 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`	`ScheduleCreateParams.Builder`	A builder for ScheduleCreateParams.
`public final class`	`ScheduleCreateParams.Body`	A request to create a schedule.
`public final class`	`ScheduleCreateParams.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<RecipientRequest>`	`recipients()`	The recipients to trigger the workflow for.
`final List<ScheduleRepeatRule>`	`repeats()`	The repeat rule for the schedule.
`final String`	`workflow()`	The key of the workflow.
`final Optional<ScheduleCreateParams.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<OffsetDateTime>`	`scheduledAt()`	The starting date and time for the schedule.
`final Optional<InlineTenantRequest>`	`tenant()`	An request to set a tenant inline.
`final JsonField<List<RecipientRequest>>`	`_recipients()`	Returns the raw JSON value of recipients.
`final JsonField<List<ScheduleRepeatRule>>`	`_repeats()`	Returns the raw JSON value of repeats.
`final JsonField<String>`	`_workflow()`	Returns the raw JSON value of workflow.
`final JsonField<ScheduleCreateParams.Data>`	`_data()`	Returns the raw JSON value of data.
`final JsonField<OffsetDateTime>`	`_endingAt()`	Returns the raw JSON value of endingAt.
`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 ScheduleCreateParams.Builder`	`toBuilder()`
`final ScheduleCreateParams.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 ScheduleCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ScheduleCreateParams.

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

- Constructor Detail
- Method Detail
  - recipients
```
 final List<RecipientRequest> recipients()
```
    The recipients to trigger the workflow for. Can inline identify users, objects, or use a list of user IDs. Limited to 1,000 recipients.
  - repeats
```
 final List<ScheduleRepeatRule> repeats()
```
    The repeat rule for the schedule.
  - workflow
```
 final String workflow()
```
    The key of the workflow.
  - data
```
 final Optional<ScheduleCreateParams.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.
  - 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.
  - _recipients
```
 final JsonField<List<RecipientRequest>> _recipients()
```
    Returns the raw JSON value of recipients.
    Unlike recipients, 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.
  - _workflow
```
 final JsonField<String> _workflow()
```
    Returns the raw JSON value of workflow.
    Unlike workflow, this method doesn't throw if the JSON field has an unexpected type.
  - _data
```
 final JsonField<ScheduleCreateParams.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.
  - _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 ScheduleCreateParams.Builder toBuilder()
```
  - _body
```
 final ScheduleCreateParams.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 ScheduleCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ScheduleCreateParams.
    The following fields are required:
    .recipients() .repeats() .workflow()

Class ScheduleCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

recipients

repeats

workflow

data

endingAt

scheduledAt

tenant

_recipients

_repeats

_workflow

_data

_endingAt

_scheduledAt

_tenant

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder