Skip to main content
PUT
Update the status of a refresh schedule
Required scopes: metrics:execute.

Authorizations

x-chatobserver-key
string
header
required

A workspace API key. Data endpoints require a service-account key with the specified scopes.

Headers

Idempotency-Key
string
required

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Required string length: 16 - 160
Pattern: ^[A-Za-z0-9:_-]+$

Path Parameters

scheduleId
string<uuid>
required

Resource identifier returned by the API.

Body

application/json
status
enum<string>
required
Available options:
active,
paused

Response

Successful response.

data
object
required
replayed
required