Create or update schedule Rule

Create or update a schedule for a rule so it runs automatically at specified times.

Use the API reference below to try the endpoint.

Create or update schedule

post

Create or update a schedule for a rule. Only rules support scheduling.

Authorizations

Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Path parameters

entity-idstringRequired

The rule's entity ID

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

Request body for create or update schedule

unitstringOptional

Schedule unit (e.g. minute, hour, day)

isEnabledbooleanOptional

isDeletebooleanOptional

Set true to remove the schedule

startAtstringOptional

Start (ISO 8601)

endAtstringOptional

End (ISO 8601)

Responses

200

OK (illustrative)

application/json

Standard API response wrapper

codestringOptional

dataanyOptional

Response payload: rule object, array of rules (list), version rows, or execution result — shape varies by endpoint

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/dev/v1/rule/{entity-id}/schedule

POST /dev/v1/rule/{entity-id}/schedule HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "unit": "minute",
  "isEnabled": true,
  "isDelete": false,
  "startAt": "2026-01-29T00:00:00+05:30",
  "endAt": "2027-01-29T00:00:00+05:30",
  "spec": {
    "minute": "0",
    "hour": "*",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*"
  },
  "inputParam": {
    "Age": 25
  }
}

{
  "code": "success",
  "message": "Success.",
  "data": {
    "scheduleId": "sch-example-1",
    "isEnabled": true
  }
}