Skip to main content
POST/api/public/v1/schedules/{id}/state

schedules.set_state

Pause or resume a schedule with the version you last read (audited).

Capability: schedule.manageCommand (idempotent)MCP tool: schedules_set_state
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)YesSchedule id
command_idbodystring (uuid)YesClient-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT.
expected_versionbodyintegerYesThe schedule version you last read (min 1, max 9007199254740991)
statebody"active" | "paused"Yes

Examples

curl -X POST "https://browlix.com/api/public/v1/schedules/<id>/state" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","expected_version":0,"state":"active"}'

Response

201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.

The field list of this reply is not published yet; read data as JSON.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
CONFLICT409No
OUTCOME_UNKNOWN202Yes
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations