Skip to main content
PUT
/
api
/
v1
/
crons
/
{id}
TypeScript SDK
import { cuey } from 'cuey';

const cron = await cuey.crons.update('cron-id', {
  webhook_url: 'https://api.example.com/webhook',
  method: 'POST',
  cron_expression: '*/30 * * * *',
  timezone: 'America/New_York',
  is_active: true
});
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cron_expression": "<string>",
    "timezone": "<string>",
    "webhook_url": "<string>",
    "method": "GET",
    "headers": {},
    "payload": {},
    "retry_config": {
      "maxRetries": 5,
      "backoffMs": 2550,
      "backoffType": "exponential"
    },
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
Updating a cron deletes all pending events created by that cron. New events are generated based on the updated schedule.

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Bearer <your-api-key>

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
webhook_url
string<uri>
required
​
cron_expression
string
required

Cron expression (e.g., '0 0 * * *')

​
method
enum<string>
default:POST
Available options:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD,
OPTIONS
​
timezone
string | null

IANA timezone identifier (e.g., 'America/New_York')

​
headers
object | null
​
payload
object | null
​
retry_config
object
​
is_active
boolean
default:true

Response

Cron updated

​
data
object
required