Skip to content

API reference

Enable or disable a pilot schedule

POST
/v1/pilot/schedules/{scheduleId}/enabled

Requires sync:write. Enablement rechecks active source/destination grants, capacity and observed property timezone. Only one schedule may be enabled per destination. Changing enabled state increments its revision. Disablement fences and cancels unfinished source and export work while retaining successful history; already dispatched provider requests cannot be recalled. Implemented and locally tested; new live scheduled delivery and controlled failure/recovery acceptance remain pending.

scheduleId
required
string
/^[A-Za-z0-9_-]{1,128}$/
object
enabled
required
boolean

Enable or disable a pilot schedule.

object
enabled
required
boolean

invalid_json or invalid_request for a query delimiter or non-exact enablement body.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: invalid_request invalid_json invalid_schedule
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

Missing, expired, revoked or reassigned key, including changes before response release.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed value: unauthorized
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable
WWW-Authenticate
required
string
Allowed value: Bearer

forbidden, source_permission_required, destination_permission_required, or schedule_enable_forbidden.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

schedule_not_found, connection_unavailable, or destination_not_found.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: not_found destination_not_found schedule_not_found pipeline_not_found connection_unavailable
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

method_not_allowed — use the method named in Allow.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed value: method_not_allowed
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable
Allow
required
string
Allowed value: POST

destination_unavailable, timezone_unverified, timezone_conflict, schedule_conflict, or sheet_capacity_exhausted.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

Request JSON exceeds 4096 bytes.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed value: request_too_large
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

Use application/json with no Content-Encoding other than identity.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: unsupported_media_type unsupported_encoding
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

automation_configuration_unavailable, credential_configuration_unavailable, or automation_unavailable.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_rate_limited automation_unavailable
error
object
code
Allowed values: invalid_request invalid_json unauthorized forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_not_found connection_unavailable destination_not_found method_not_allowed destination_unavailable timezone_unverified timezone_conflict schedule_conflict sheet_capacity_exhausted request_too_large unsupported_media_type unsupported_encoding automation_configuration_unavailable credential_configuration_unavailable automation_unavailable